incubator-nuttx/.github/workflows/doc.yml

38 lines
1.1 KiB
YAML
Raw Normal View History

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
2020-08-15 04:01:22 +08:00
name: "Build Documentation"
on:
pull_request:
2020-08-15 04:01:22 +08:00
push:
jobs:
docs:
2020-08-15 04:01:22 +08:00
runs-on: ubuntu-latest
steps:
2020-08-15 04:01:22 +08:00
- uses: actions/checkout@v1
- uses: actions/setup-python@v2
with:
python-version: '3.8'
- name: Generate requirements.txt file
run: |
cd Documentation/
pip3 install pipenv
pipenv lock -r > requirements.txt
2020-08-15 04:01:22 +08:00
- uses: ammaraskar/sphinx-action@master
with:
2020-08-15 04:01:22 +08:00
docs-folder: "Documentation/"
- uses: actions/upload-artifact@v2
with:
2020-08-15 04:01:22 +08:00
name: sphinx-docs
path: Documentation/_build/html/