This is an automated email from the ASF dual-hosted git repository.
acassis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new 6675dfa02c8 docs/documentation: Mention installation of PlantUML
6675dfa02c8 is described below
commit 6675dfa02c85dfc790a9fd3719e32472125d0f8a
Author: Matteo Golin <[email protected]>
AuthorDate: Mon Mar 2 11:18:30 2026 -0500
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 <[email protected]>
---
Documentation/contributing/documentation.rst | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/Documentation/contributing/documentation.rst
b/Documentation/contributing/documentation.rst
index b63f9f7122b..e17d6e27836 100644
--- a/Documentation/contributing/documentation.rst
+++ b/Documentation/contributing/documentation.rst
@@ -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
