commit fdb47a006130f1bba1a152802204c4804fc7ae45
author Shawn Shan <Shawn.Shan@arm.com> Tue Mar 30 17:16:43 2021 +0800
committer Shawn Shan <Shawn.Shan@arm.com> Mon Apr 12 15:31:52 2021 +0800
tree ff1860e652b4c00e54b58ac179d2b7aa67e70359
parent 19504a550ce608765322d7e4b5dc1601159627f1

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>

docs/CMakeLists.txt

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 85f63f0..950f49b 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -36,8 +36,8 @@
 )
 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}
 )
 

docs/conf.py

diff --git a/build_docs/conf.py b/docs/conf.py
similarity index 100%
rename from build_docs/conf.py
rename to docs/conf.py

docs/getting_started/tfm_build_instruction.rst

diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst
index 5576327..cdfcab5 100644
--- a/docs/getting_started/tfm_build_instruction.rst
+++ b/docs/getting_started/tfm_build_instruction.rst
@@ -440,7 +440,10 @@
 .. 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