mirror of
https://github.com/apache/nuttx.git
synced 2026-05-20 20:44:39 +08:00
docs/documentation: Mention installation of PlantUML
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:
committed by
Alan C. Assis
parent
cd68f50ba5
commit
6675dfa02c
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user