Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-08-01 20:28:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs/documentation: Mention installation of PlantUML

Browse source 
Include information about installing PlantUML for the build process now
that it has been included for UML diagram rendering.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
This commit is contained in:
Matteo Golin 2026-03-02 11:18:30 -05:00 • committed by Alan C. Assis
parent cd68f50ba5
commit 6675dfa02c
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Documentation/contributing/documentation.rst
View file

@ -20,7 +20,7 @@ To render the Documentation locally, you should clone the NuttX main repository
project `site <https://github.com/pyenv/pyenv#installation>`_.
.. code-block:: console
$ pip3 install pipenv
$ cd Documentation/
$ # install the dependencies into a virtual environment
@ -28,7 +28,15 @@ To render the Documentation locally, you should clone the NuttX main repository
$ # activate the virtual environment
$ pipenv shell
2. Build documentation:
2. `Install the PlantUML tool <https://www.javiljoen.net/n/installing-plantuml.html>`_
(used to render UML diagrams) and ensure it is on your ``PATH``.
.. code:: console
$ sudo apt install plantuml
$ plantuml -version
3. Build documentation:
.. code-block:: console