commit f1a13aa30369fbc06de4dd0795db84e21e3d00c2
author Arunachalam Ganapathy <arunachalam.ganapathy@arm.com> Fri Nov 11 15:07:12 2022 +0000
committer Arunachalam Ganapathy <arunachalam.ganapathy@arm.com> Mon Nov 14 16:47:34 2022 +0000
tree 5f5749bb143f447a22fcfd10b55bd3814b7f4f48
parent 883dd8664c0b07eb4329ab2758876f16f7dc99c2

fix(docs): add support for readthedocs

- Remove cmake variables from conf.py.in and rename it to confy.py
- Remove dependency on package plantuml
- Move tools/requirements.txt to docs
- Scale down image cca_software_arch.png

These changes make documentation build compatible when built using
cmake or readthedocs.

Signed-off-by: Arunachalam Ganapathy <arunachalam.ganapathy@arm.com>
Change-Id: I4331e6a435b25d1c50439ac85e396737d8042feb

docs/getting_started/getting-started.rst

diff --git a/docs/getting_started/getting-started.rst b/docs/getting_started/getting-started.rst
index 3f9392f..72889e4 100644
--- a/docs/getting_started/getting-started.rst
+++ b/docs/getting_started/getting-started.rst
@@ -48,8 +48,6 @@
    "Git",, "Firmware, Documentation"
    "Graphviz dot",">v2.38.0","Documentation"
    "docutils",">v2.38.0","Documentation"
-   "JRE",">=10.0","Documentation"
-   "plantuml",,"Documentation"
 
 .. _getting_started_toolchain:
 
@@ -107,13 +105,8 @@
 
 .. code:: shell
 
-    sudo apt-get install -y git build-essential python3 python3-pip make ninja-build default-jre
+    sudo apt-get install -y git build-essential python3 python3-pip make ninja-build
     sudo snap install cmake
-    wget https://github.com/plantuml/plantuml/releases/download/v1.2022.7/plantuml-1.2022.7.jar -P <plantuml install path>
-
-.. note::
-
-    platUML and JRE are only required for documentation build.
 
 2. Verify cmake version:
 
@@ -125,12 +118,11 @@
 
     Please download cmake 3.19 or later version from https://cmake.org/download/.
 
-3. Add CMake and platUML path into environment:
+3. Add CMake path into environment:
 
 .. code-block:: bash
 
     export PATH=<CMake path>/bin:$PATH
-    export PLANTUML_JAR_PATH=<plantuml install path>/plantuml.jar
 
 ###########################
 Install python dependencies
@@ -141,14 +133,14 @@
     The installation of Python dependencies is an optional step. This is required only
     if building documentation.
 
-RMM's ``tools/requirements.txt`` file declares additional Python dependencies.
+RMM's ``docs/requirements.txt`` file declares additional Python dependencies.
 Install them with ``pip3``:
 
 .. code-block:: bash
 
     pip3 install --upgrade pip
     cd <rmm source folder>
-    pip3 install -r tools/requirements.txt
+    pip3 install -r docs/requirements.txt
 
 .. _getting_started_get_source: