Docs: Minor fixes in build instructions
- Fix broken link to the TF-M application example.
- Add rsvg-convert to list of tools to install on Linux in order to
build the documentation.
- Make it clearer that PLANTUML_JAR_PATH must be set whenever the
documentation is built (instead of listing this as an initial
installation step).
Change-Id: I85b3e971d584e1dbaba36e2b3b784a737d3ab50b
Signed-off-by: Nik Dewally <Nik.Dewally@arm.com>
diff --git a/docs/building/documentation_generation.rst b/docs/building/documentation_generation.rst
index 967c338..2dca171 100644
--- a/docs/building/documentation_generation.rst
+++ b/docs/building/documentation_generation.rst
@@ -38,21 +38,28 @@
.. group-tab:: Linux
+ Install the required tools:
+
.. code-block:: bash
sudo apt-get install -y doxygen graphviz default-jre
mkdir ~/plantuml
curl -L http://sourceforge.net/projects/plantuml/files/plantuml.jar/download --output ~/plantuml/plantuml.jar
- export PLANTUML_JAR_PATH=~/plantuml/plantuml.jar
# For PDF generation
- sudo apt-get install -y doxygen-latex
+ sudo apt-get install -y doxygen-latex librsvg2-bin
# Install the required Python modules
pip3 install --upgrade pip
- cd trusted-firmware-m
+ cd <TF-M base folder>
pip3 install -r docs/requirements.txt
+ Set the environment variables:
+
+ .. code-block:: bash
+
+ export PLANTUML_JAR_PATH=~/plantuml/plantuml.jar
+
.. group-tab:: Windows
Download and install the following tools:
@@ -222,4 +229,4 @@
--------------
-*Copyright (c) 2017-2023, Arm Limited. All rights reserved.*
+*Copyright (c) 2017-2024, Arm Limited. All rights reserved.*
diff --git a/docs/building/tfm_build_instruction.rst b/docs/building/tfm_build_instruction.rst
index 7b1b5d2..53c43fd 100644
--- a/docs/building/tfm_build_instruction.rst
+++ b/docs/building/tfm_build_instruction.rst
@@ -346,7 +346,7 @@
Basic SPE integration
=====================
Refer to the
-`example <https://git.trustedfirmware.org/TF-M/tf-m-extras.git/tree/examples/tf-m-example-ns-app>`__
+`example <https://git.trustedfirmware.org/TF-M/tf-m-extras.git/+/refs/heads/main/examples/tf-m-example-ns-app/>`__
of TF-M applications in **tf-m-extras** repository.
--------------