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/CMakeLists.txt

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 9f43b03..0e3f1a6 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -10,20 +10,18 @@
 find_package(Python3)
 find_package(Sphinx)
 find_package(PythonModules COMPONENTS sphinx-rtd-theme sphinxcontrib.plantuml)
-find_package(PlantUML)
+find_package(Git)
 
 set(SPHINXCFG_OUTPUT_PATH ${CMAKE_CURRENT_BINARY_DIR}/user_guide)
 
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in ${CMAKE_CURRENT_BINARY_DIR}/conf.py @ONLY)
+if (SPHINX_FOUND AND PY_SPHINX-RTD-THEME_FOUND AND PY_SPHINXCONTRIB.PLANTUML AND GIT_FOUND)
 
-if (SPHINX_FOUND AND PLANTUML_FOUND AND PY_SPHINX-RTD-THEME_FOUND AND PY_SPHINXCONTRIB.PLANTUML)
-
-    file(GLOB_RECURSE SPHINXCFG_DOC_FILES ${CMAKE_CURRENT_SOURCE_DIR} *.rst)
+    file(GLOB_RECURSE SPHINXCFG_DOC_FILES ${CMAKE_CURRENT_SOURCE_DIR} *.rst conf.py)
 
     add_custom_command(OUTPUT "${SPHINXCFG_OUTPUT_PATH}/html/index.html"
         OUTPUT "${SPHINXCFG_OUTPUT_PATH}/html/"
-        COMMAND "${SPHINX_EXECUTABLE}" -W -b html "${CMAKE_CURRENT_SOURCE_DIR}" "${SPHINXCFG_OUTPUT_PATH}/html" -c ${CMAKE_CURRENT_BINARY_DIR}
-        WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+        COMMAND "${SPHINX_EXECUTABLE}" -W -b html "${CMAKE_CURRENT_SOURCE_DIR}" "${SPHINXCFG_OUTPUT_PATH}/html"
+        WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}/docs"
         DEPENDS ${SPHINXCFG_DOC_FILES}
     )
     add_custom_target(rmm_docs_userguide_html