aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShawn Shan <Shawn.Shan@arm.com>2021-03-30 17:16:43 +0800
committerShawn Shan <Shawn.Shan@arm.com>2021-04-12 15:31:52 +0800
commitfdb47a006130f1bba1a152802204c4804fc7ae45 (patch)
treeff1860e652b4c00e54b58ac179d2b7aa67e70359
parent19504a550ce608765322d7e4b5dc1601159627f1 (diff)
downloadtrusted-firmware-m-fdb47a006130f1bba1a152802204c4804fc7ae45.tar.gz
Docs: Deprecate 'build_docs' folder
With the prefix 'build', user may delete 'build_docs' accidentally. Deprecate 'build_docs' folder and move the only files 'conf.py' to 'docs' folder. Change-Id: I701e279861afdc9b0f6cfd10b343643acd77e51d Signed-off-by: Shawn Shan <Shawn.Shan@arm.com>
-rw-r--r--docs/CMakeLists.txt4
-rw-r--r--docs/conf.py (renamed from build_docs/conf.py)0
-rw-r--r--docs/getting_started/tfm_build_instruction.rst5
3 files changed, 6 insertions, 3 deletions
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 85f63f00f..950f49b76 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -36,8 +36,8 @@ add_custom_target(tfm_docs_sphinx_cfg
)
add_custom_command(OUTPUT ${SPHINX_TMP_DOC_DIR}/conf.py
COMMAND ${CMAKE_COMMAND} -E make_directory ${SPHINX_TMP_DOC_DIR}
- COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/build_docs/conf.py ${SPHINX_TMP_DOC_DIR}/conf.py
- MAIN_DEPENDENCY ${CMAKE_SOURCE_DIR}/build_docs/conf.py
+ COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/docs/conf.py ${SPHINX_TMP_DOC_DIR}/conf.py
+ MAIN_DEPENDENCY ${CMAKE_SOURCE_DIR}/docs/conf.py
BYPRODUCTS ${SPHINX_TMP_DOC_DIR}
)
diff --git a/build_docs/conf.py b/docs/conf.py
index 5a8361826..5a8361826 100644
--- a/build_docs/conf.py
+++ b/docs/conf.py
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst
index 5576327ed..cdfcab549 100644
--- a/docs/getting_started/tfm_build_instruction.rst
+++ b/docs/getting_started/tfm_build_instruction.rst
@@ -440,7 +440,10 @@ targets.
.. code-block:: bash
# Build the documentation from build_docs directory
- cd <TF-M base folder>/ build_docs/
+ cd <TF-M base folder>
+ mkdir build_docs
+ cp docs/conf.py build_docs/conf.py
+ cd build_docs
sphinx-build ./ user_guide
# Build the documentation from a custom location