mirror of
https://github.com/apache/nuttx.git
synced 2026-03-27 10:39:28 +08:00
16aca58275
This commit adds support for PlantUML to the Documentation build process. UML diagrams can be written in PlantUML syntax and then rendered during the build process. Version control no longer needs to track these UML diagrams as images, and we can modify them easily. Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
56 lines
1.4 KiB
YAML
56 lines
1.4 KiB
YAML
# 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.
|
|
#
|
|
---
|
|
name: "Build Documentation"
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
paths:
|
|
- 'Documentation/**'
|
|
|
|
pull_request:
|
|
paths:
|
|
- 'Documentation/**'
|
|
|
|
concurrency:
|
|
group: docs-${{ github.event.pull_request.number || github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
build-html:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
- uses: actions/setup-python@v6
|
|
with:
|
|
python-version: '3.10'
|
|
- name: Generate Documentation
|
|
run: |
|
|
cd Documentation/
|
|
sudo apt update
|
|
sudo apt install plantuml
|
|
pip3 install pipenv
|
|
pipenv install
|
|
pipenv run make html
|
|
- uses: actions/upload-artifact@v6
|
|
with:
|
|
name: sphinx-docs
|
|
path: |
|
|
Documentation/_build/html/
|
|
Documentation/_build/latex/*.pdf
|