Build: Convert docs directory to modern cmake
Add cmake files to docs directory. Remove unneeded cmake files.
By default, the targets are generated but not run by `make all` or
`make`. The documentation can be generated by running `make docs`
Please refer to the tfm_build_instructions document for
reference examples.
WARNING: This change will not build in isolation, it requires _all_
other cmake changes to successfully build. It is split out only for ease
of understanding.
Change-Id: I1b004a8f8ccfba2df901d91b093576fdc6bfa40d
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
Signed-off-by: Raef Coles <raef.coles@arm.com>
diff --git a/docs/getting_started/tfm_build_instruction.rst b/docs/getting_started/tfm_build_instruction.rst
index a8e890b..2fb81c4 100644
--- a/docs/getting_started/tfm_build_instruction.rst
+++ b/docs/getting_started/tfm_build_instruction.rst
@@ -188,8 +188,8 @@
Using the CMake build-system
----------------------------
-Building PDF output is optional and can be disabled by removing LaTex from the
-PATH.
+Building PDF output can be requested by invoking `tfm_docs_userguide_pdf/
+tfm_docs_userguide_pdf`
.. Note::
For building the documentation all tools needed to build the firmware must
@@ -202,12 +202,13 @@
cd <TF-M base folder>
mkdir cmake_doc
cd cmake_doc
- cmake ../ -G"Unix Makefiles" -DTARGET_PLATFORM=AN521 -DCOMPILER=GNUARM
- cmake --build ./ -- install_doc
+ cmake -S .. -B . -G "Unix Makefiles" -DTFM_PLATFORM=mps2/an521 -DCMAKE_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake
+ make tfm_docs_refman_html
+ make tfm_docs_refman_pdf
The documentation files will be available under the directory::
- cmake_doc/install/doc/reference_manual
+ cmake_doc/docs/reference_manual
Building the User Guide
^^^^^^^^^^^^^^^^^^^^^^^
@@ -216,12 +217,13 @@
cd <TF-M base folder>
mkdir cmake_doc
cd cmake_doc
- cmake ../ -G"Unix Makefiles" -DTARGET_PLATFORM=AN521 -DCOMPILER=ARMCLANG
- cmake --build ./ -- install_userguide
+ cmake -S .. -B . -G "Unix Makefiles" -DTFM_PLATFORM=mps2/an521 -DCMAKE_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake
+ make tfm_docs_userguide_html
+ make tfm_docs_userguide_pdf
The documentation files will be available under the directory::
- cmake_doc/install/doc/user_guide
+ cmake_doc/docs/user_guide
Manually using documentation generation tools
---------------------------------------------