Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-05-28 11:56:10 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

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
Documentation/contributing/documentation.rst
+10 -2
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>`_. project `site <https://github.com/pyenv/pyenv#installation>`_.
.. code-block:: console .. code-block:: console
$ pip3 install pipenv $ pip3 install pipenv
$ cd Documentation/ $ cd Documentation/
$ # install the dependencies into a virtual environment $ # 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 $ # activate the virtual environment
$ pipenv shell $ 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 .. code-block:: console