commit 3ae2ac3022fdb07adcc6272b9cb0761075b5f991
author Anton Komlev <anton.komlev@arm.com> Tue Jan 03 14:56:47 2023 +0000
committer Anton Komlev <anton.komlev@arm.com> Tue Jan 03 21:52:57 2023 +0000
tree 0e897ec9731fd969ec4d0015bc4543b0e24bfdac
parent ab39c71223e036739fa24cf7dc849c4f3a1c76a8

Docs: Fix broken PDF version of the User guide

- Limit FWU design document content table depth to comply with Latex
- Reduce the Design Documents content table to titles only

Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: Ia9df1b2a896f7a662bdd84e671fc091a227e25e6

docs/CMakeLists.txt

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 352f415..cf3e364 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -40,22 +40,13 @@
 )
 add_dependencies(docs tfm_docs_userguide_html)
 
-add_custom_command(OUTPUT "${SPHINXCFG_OUTPUT_PATH}/latex/TF-M.tex"
-    OUTPUT "${SPHINXCFG_OUTPUT_PATH}/latex/"
-    COMMAND "${SPHINX_EXECUTABLE}" -b latex "${SPHINXCFG_SOURCE_PATH}" "${SPHINXCFG_OUTPUT_PATH}/latex"
-    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
-    DEPENDS tfm_docs_sphinx_cfg
+add_custom_target(tfm_docs_userguide_pdf ALL
+    COMMAND "${SPHINX_EXECUTABLE}" -W -b latex -j auto -c ${SPHINXCFG_CONFIG_PATH} ${SPHINXCFG_SOURCE_PATH} "${SPHINXCFG_OUTPUT_PATH}/latex"
+    COMMAND ${PDFLATEX_COMPILER} -output-directory "${SPHINXCFG_OUTPUT_PATH}/latex" TF-M.tex
+    COMMAND ${CMAKE_COMMAND} -E copy "${SPHINXCFG_OUTPUT_PATH}/latex/TF-M.pdf" "${SPHINXCFG_OUTPUT_PATH}/tf-m_user_guide.pdf"
+    WORKING_DIRECTORY ${SPHINXCFG_SOURCE_PATH}
     DEPENDS ${SPHINXCFG_DOC_FILES}
 )
-add_custom_command(OUTPUT "${SPHINXCFG_OUTPUT_PATH}/latex/TF-M.pdf"
-    COMMAND ${PDFLATEX_COMPILER} TF-M.tex
-    COMMAND ${CMAKE_COMMAND} -E copy TF-M.tex ${SPHINXCFG_OUTPUT_PATH}/tf-m_user_guide.pdf
-    WORKING_DIRECTORY ${SPHINXCFG_OUTPUT_PATH}/latex/
-    DEPENDS "${SPHINXCFG_OUTPUT_PATH}/latex/TF-M.tex"
-)
-add_custom_target(tfm_docs_userguide_pdf
-    DEPENDS "${SPHINXCFG_OUTPUT_PATH}/latex/TF-M.pdf"
-)
 add_dependencies(docs tfm_docs_userguide_pdf)
 
 ################################## DOXYGEN #####################################

docs/technical_references/design_docs/index.rst

diff --git a/docs/technical_references/design_docs/index.rst b/docs/technical_references/design_docs/index.rst
index bdd2d03..e091bbb 100644
--- a/docs/technical_references/design_docs/index.rst
+++ b/docs/technical_references/design_docs/index.rst
@@ -2,7 +2,7 @@
 ================
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
     :glob:
 
     */index

docs/technical_references/design_docs/tfm_fwu_service.rst

diff --git a/docs/technical_references/design_docs/tfm_fwu_service.rst b/docs/technical_references/design_docs/tfm_fwu_service.rst
index 48c2ea3..ab3c294 100644
--- a/docs/technical_references/design_docs/tfm_fwu_service.rst
+++ b/docs/technical_references/design_docs/tfm_fwu_service.rst
@@ -7,6 +7,7 @@
 :Contact: Sherry Zhang <Sherry.Zhang2@arm.com>
 
 .. contents:: Table of Contents
+   :depth: 3
 
 ***************************************
 Introduction of Firmware Update service