blob: 352f41586dba639b8deaae511a408c90dc1fe407 [file] [log] [blame]
Minos Galanakisdff2eae2020-07-21 15:13:52 +01001#-------------------------------------------------------------------------------
Summer Qine6cd5e12021-06-23 14:26:17 +08002# Copyright (c) 2020-2021, Arm Limited. All rights reserved.
Minos Galanakisdff2eae2020-07-21 15:13:52 +01003#
4# SPDX-License-Identifier: BSD-3-Clause
5#
6#-------------------------------------------------------------------------------
7
Raef Coles69817322020-10-19 14:14:14 +01008cmake_minimum_required(VERSION 3.15)
Minos Galanakisdff2eae2020-07-21 15:13:52 +01009
10add_custom_target(docs)
11
Anton Komlev6be16032021-10-13 21:51:23 +010012list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
Anton Komlevceafd012021-10-11 23:21:11 +010013
Minos Galanakisdff2eae2020-07-21 15:13:52 +010014find_package(Sphinx)
Minos Galanakisdff2eae2020-07-21 15:13:52 +010015find_package(Doxygen 1.8.0)
16find_package(LATEX COMPONENTS PDFLATEX)
17
18################################## ENV #########################################
19
Anton Komlev6f1e5492022-06-16 19:08:57 +010020project("Trusted Firmware M. Documentation" LANGUAGES)
Anton Komlevceafd012021-10-11 23:21:11 +010021
Anton Komlevb813dbc2022-04-01 21:12:16 +010022set(SPHINXCFG_SOURCE_PATH ${CMAKE_CURRENT_SOURCE_DIR})
23set(SPHINXCFG_CONFIG_PATH ${CMAKE_CURRENT_SOURCE_DIR})
Minos Galanakisdff2eae2020-07-21 15:13:52 +010024set(SPHINXCFG_OUTPUT_PATH ${CMAKE_CURRENT_BINARY_DIR}/user_guide)
Anton Komlevb813dbc2022-04-01 21:12:16 +010025
Minos Galanakisdff2eae2020-07-21 15:13:52 +010026set(DOXYCFG_OUTPUT_PATH ${CMAKE_CURRENT_BINARY_DIR}/reference_manual)
27set(DOXYCFG_DOXYGEN_CFG_DIR ${CMAKE_SOURCE_DIR}/doxygen)
28
29# Enable to request the interface to build the doxygen documentation as well
30set(DOXYCFG_DOXYGEN_BUILD False)
31
32################################## SPHINX ######################################
Minos Galanakisdff2eae2020-07-21 15:13:52 +010033
Anton Komlev6f1e5492022-06-16 19:08:57 +010034file(GLOB_RECURSE SPHINXCFG_DOC_FILES ${SPHINXCFG_SOURCE_PATH}/*.rst ${SPHINXCFG_SOURCE_PATH}/*.md)
Minos Galanakisdff2eae2020-07-21 15:13:52 +010035
Anton Komlev6f1e5492022-06-16 19:08:57 +010036add_custom_target(tfm_docs_userguide_html ALL
37 COMMAND "${SPHINX_EXECUTABLE}" -W -b html -j auto -c ${SPHINXCFG_CONFIG_PATH} ${SPHINXCFG_SOURCE_PATH} "${SPHINXCFG_OUTPUT_PATH}/html"
38 WORKING_DIRECTORY ${SPHINXCFG_SOURCE_PATH}
39 DEPENDS ${SPHINXCFG_DOC_FILES}
40)
41add_dependencies(docs tfm_docs_userguide_html)
Minos Galanakisdff2eae2020-07-21 15:13:52 +010042
Anton Komlev6f1e5492022-06-16 19:08:57 +010043add_custom_command(OUTPUT "${SPHINXCFG_OUTPUT_PATH}/latex/TF-M.tex"
44 OUTPUT "${SPHINXCFG_OUTPUT_PATH}/latex/"
45 COMMAND "${SPHINX_EXECUTABLE}" -b latex "${SPHINXCFG_SOURCE_PATH}" "${SPHINXCFG_OUTPUT_PATH}/latex"
46 WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
47 DEPENDS tfm_docs_sphinx_cfg
48 DEPENDS ${SPHINXCFG_DOC_FILES}
49)
50add_custom_command(OUTPUT "${SPHINXCFG_OUTPUT_PATH}/latex/TF-M.pdf"
51 COMMAND ${PDFLATEX_COMPILER} TF-M.tex
52 COMMAND ${CMAKE_COMMAND} -E copy TF-M.tex ${SPHINXCFG_OUTPUT_PATH}/tf-m_user_guide.pdf
53 WORKING_DIRECTORY ${SPHINXCFG_OUTPUT_PATH}/latex/
54 DEPENDS "${SPHINXCFG_OUTPUT_PATH}/latex/TF-M.tex"
55)
56add_custom_target(tfm_docs_userguide_pdf
57 DEPENDS "${SPHINXCFG_OUTPUT_PATH}/latex/TF-M.pdf"
58)
59add_dependencies(docs tfm_docs_userguide_pdf)
Minos Galanakisdff2eae2020-07-21 15:13:52 +010060
61################################## DOXYGEN #####################################
62
Anton Komlev6f1e5492022-06-16 19:08:57 +010063configure_file(${CMAKE_SOURCE_DIR}/doxygen/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
64file(GLOB_RECURSE DOXYCFG_DOC_FILES ${CMAKE_SOURCE_DIR}/*.c ${CMAKE_SOURCE_DIR}/*.h)
Minos Galanakisdff2eae2020-07-21 15:13:52 +010065
Anton Komlev6f1e5492022-06-16 19:08:57 +010066add_custom_command(OUTPUT ${DOXYCFG_OUTPUT_PATH}/html
67 OUTPUT ${DOXYCFG_OUTPUT_PATH}/latex
68 OUTPUT ${DOXYCFG_OUTPUT_PATH}/latex/refman.pdf
69 COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
70 WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
71 DEPENDS ${DOXYCFG_DOC_FILES}
72)
73add_custom_target(tfm_docs_refman_html ALL
74 WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
75 DEPENDS ${DOXYCFG_OUTPUT_PATH}/html
76)
77add_dependencies(docs tfm_docs_refman_html)
Minos Galanakisdff2eae2020-07-21 15:13:52 +010078
Anton Komlev6f1e5492022-06-16 19:08:57 +010079add_custom_command(OUTPUT "${DOXYCFG_OUTPUT_PATH}/latex/refman.pdf"
80 COMMAND "${PDFLATEX_COMPILER} refman.tex"
81 COMMAND ${CMAKE_COMMAND} -E copy refman.tex ${DOXYCFG_OUTPUT_PATH}/tf-m_reference_manual.pdf
82 WORKING_DIRECTORY ${DOXYCFG_OUTPUT_PATH}/latex/
83 DEPENDS "${DOXYCFG_OUTPUT_PATH}/latex/refman.tex"
84)
85add_custom_target(tfm_docs_refman_pdf
86 DEPENDS ${DOXYCFG_OUTPUT_PATH}/latex/refman.pdf
87 DEPENDS tfm_docs_refman_html
88)
89add_dependencies(docs tfm_docs_refman_pdf)
Minos Galanakisdff2eae2020-07-21 15:13:52 +010090