mirror of
https://github.com/apache/nuttx.git
synced 2026-08-01 20:28:58 +00:00
docs/plantuml: Add PlantUML support to Documentation build
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>
This commit is contained in:
parent
37226646fc
commit
16aca58275
4 changed files with 587 additions and 306 deletions
2
.github/workflows/doc.yml
vendored
2
.github/workflows/doc.yml
vendored
|
|
@ -42,6 +42,8 @@ jobs:
|
|||
- name: Generate Documentation
|
||||
run: |
|
||||
cd Documentation/
|
||||
sudo apt update
|
||||
sudo apt install plantuml
|
||||
pip3 install pipenv
|
||||
pipenv install
|
||||
pipenv run make html
|
||||
|
|
|
|||
|
|
@ -19,3 +19,4 @@ sphinx-tags = "*"
|
|||
sphinx-design = "*"
|
||||
sphinx-collapse = "*"
|
||||
MarkupSafe = "*"
|
||||
sphinxcontrib-plantuml = "*"
|
||||
|
|
|
|||
881
Documentation/Pipfile.lock
generated
881
Documentation/Pipfile.lock
generated
File diff suppressed because it is too large
Load diff
|
|
@ -62,6 +62,7 @@ extensions = [
|
|||
"sphinx_tags",
|
||||
"sphinx_design",
|
||||
"sphinx_collapse",
|
||||
"sphinxcontrib.plantuml",
|
||||
]
|
||||
|
||||
source_suffix = [".rst", ".md"]
|
||||
|
|
@ -80,7 +81,13 @@ templates_path = ["_templates"]
|
|||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "legacy_README.md", "venv"]
|
||||
exclude_patterns = [
|
||||
"_build",
|
||||
"Thumbs.db",
|
||||
".DS_Store",
|
||||
"legacy_README.md",
|
||||
"venv",
|
||||
]
|
||||
|
||||
# list of documentation versions to offer (besides latest). this will be
|
||||
# overridden by command line option but we can provide a sane default
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue