Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 1 | cmake_minimum_required(VERSION 3.8.2) |
| 2 | project(Zephyr-Kernel-Doc VERSION ${PROJECT_VERSION} LANGUAGES) |
| 3 | |
| 4 | set(ZEPHYR_BASE $ENV{ZEPHYR_BASE}) |
| 5 | |
| 6 | message(STATUS "Zephyr base: ${ZEPHYR_BASE}") |
| 7 | |
Sebastian Bøe | 93230a5 | 2018-09-28 13:10:57 +0200 | [diff] [blame^] | 8 | include(${ZEPHYR_BASE}/cmake/version.cmake) |
| 9 | |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 10 | find_package(PythonInterp 3.4) |
| 11 | set(DOXYGEN_SKIP_DOT True) |
| 12 | find_package(Doxygen REQUIRED) |
| 13 | |
| 14 | find_program( |
| 15 | SPHINXBUILD |
| 16 | sphinx-build |
| 17 | ) |
| 18 | if(${SPHINXBUILD} STREQUAL SPHINXBUILD-NOTFOUND) |
| 19 | message(FATAL_ERROR "The 'sphinx-build' command was not found. Make sure you have Sphinx installed.") |
| 20 | endif() |
| 21 | |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 22 | # Note that this won't force fatal error if latexmk is not found. |
| 23 | # Not having LaTeX tools should not prevent people from generating HTML docs. |
| 24 | find_program( |
| 25 | LATEXMK |
| 26 | latexmk |
| 27 | ) |
| 28 | if(${LATEXMK} STREQUAL LATEXMK-NOTFOUND) |
| 29 | message(WARNING "The 'latexmk' command was not found. Targets to build PDF will not be available.") |
| 30 | endif() |
| 31 | |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 32 | if(NOT DEFINED SPHINXOPTS) |
| 33 | set(SPHINXOPTS -q) |
Carles Cufi | d505ca7 | 2018-07-13 12:37:13 +0200 | [diff] [blame] | 34 | else() |
| 35 | separate_arguments(SPHINXOPTS) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 36 | endif() |
| 37 | |
Carles Cufi | 896a696 | 2018-08-16 13:45:59 +0200 | [diff] [blame] | 38 | if(NOT DEFINED SPHINX_OUTPUT_DIR) |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 39 | set(SPHINX_OUTPUT_DIR_HTML ${CMAKE_CURRENT_BINARY_DIR}/html) |
| 40 | set(SPHINX_OUTPUT_DIR_LATEX ${CMAKE_CURRENT_BINARY_DIR}/latex) |
| 41 | set(SPHINX_OUTPUT_DIR_PDF ${CMAKE_CURRENT_BINARY_DIR}/pdf) |
| 42 | else() |
| 43 | set(SPHINX_OUTPUT_DIR_HTML ${SPHINX_OUTPUT_DIR}) |
| 44 | set(SPHINX_OUTPUT_DIR_LATEX ${SPHINX_OUTPUT_DIR}) |
| 45 | set(SPHINX_OUTPUT_DIR_PDF ${SPHINX_OUTPUT_DIR}) |
Carles Cufi | 896a696 | 2018-08-16 13:45:59 +0200 | [diff] [blame] | 46 | endif() |
| 47 | |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 48 | if(NOT DEFINED DOC_TAG) |
| 49 | set(DOC_TAG development) |
| 50 | endif() |
| 51 | |
| 52 | # Internal variables. |
Carles Cufi | 2af9a9e | 2018-07-13 15:32:36 +0200 | [diff] [blame] | 53 | set(ALLSPHINXOPTS -d ${CMAKE_CURRENT_BINARY_DIR}/doctrees ${SPHINXOPTS}) |
Carles Cufi | 60c5540 | 2018-07-15 18:57:01 +0200 | [diff] [blame] | 54 | if("-q" IN_LIST ALLSPHINXOPTS) |
| 55 | set(SPHINX_USES_TERMINAL ) |
| 56 | else() |
| 57 | set(SPHINX_USES_TERMINAL USES_TERMINAL) |
| 58 | endif() |
| 59 | |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 60 | # the i18n builder cannot share the environment and doctrees with the others |
Carles Cufi | d505ca7 | 2018-07-13 12:37:13 +0200 | [diff] [blame] | 61 | set(I18NSPHINXOPTS ${SPHINXOPTS}) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 62 | |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 63 | set(DOXYFILE_IN ${CMAKE_CURRENT_LIST_DIR}/zephyr.doxyfile.in) |
| 64 | set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/zephyr.doxyfile) |
| 65 | set(RST_OUT ${CMAKE_CURRENT_BINARY_DIR}/rst) |
| 66 | set(DOC_LOG ${CMAKE_CURRENT_BINARY_DIR}/doc.log) |
| 67 | set(DOXY_LOG ${CMAKE_CURRENT_BINARY_DIR}/doxy.log) |
| 68 | set(SPHINX_LOG ${CMAKE_CURRENT_BINARY_DIR}/sphinx.log) |
| 69 | set(DOC_WARN ${CMAKE_CURRENT_BINARY_DIR}/doc.warnings) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 70 | |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 71 | configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 72 | |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 73 | set(ARGS ${DOXYFILE_OUT}) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 74 | |
| 75 | add_custom_target( |
| 76 | doxy |
| 77 | COMMAND ${CMAKE_COMMAND} |
| 78 | -DCOMMAND=${DOXYGEN_EXECUTABLE} |
| 79 | -DARGS="${ARGS}" |
| 80 | -DOUTPUT_FILE=${DOXY_LOG} |
| 81 | -DERROR_FILE=${DOXY_LOG} |
Carles Cufi | 2af9a9e | 2018-07-13 15:32:36 +0200 | [diff] [blame] | 82 | -DWORKING_DIRECTORY=${CMAKE_CURRENT_LIST_DIR} |
Carles Cufi | 45d58a7 | 2018-07-12 17:34:29 +0200 | [diff] [blame] | 83 | -P ${ZEPHYR_BASE}/cmake/util/execute_process.cmake |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 84 | ) |
| 85 | |
| 86 | add_custom_target( |
| 87 | pristine |
| 88 | COMMAND ${CMAKE_COMMAND} -P ${ZEPHYR_BASE}/cmake/pristine.cmake |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 89 | ) |
| 90 | |
| 91 | add_custom_target( |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 92 | content |
Carles Cufi | a0dbc7a | 2018-08-06 11:51:53 +0200 | [diff] [blame] | 93 | # Copy all files in doc/ to the rst folder |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 94 | COMMAND ${CMAKE_COMMAND} -E env |
| 95 | ZEPHYR_BUILD=${CMAKE_CURRENT_BINARY_DIR} |
Carles Cufi | a0dbc7a | 2018-08-06 11:51:53 +0200 | [diff] [blame] | 96 | ${PYTHON_EXECUTABLE} scripts/extract_content.py -a ${RST_OUT} doc |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 97 | # Copy the .rst files in samples/ and boards/ to the rst folder |
| 98 | COMMAND ${CMAKE_COMMAND} -E env |
| 99 | ZEPHYR_BUILD=${CMAKE_CURRENT_BINARY_DIR} |
| 100 | ${PYTHON_EXECUTABLE} scripts/extract_content.py ${RST_OUT} samples boards |
| 101 | # Copy the .rst files in samples/ and boards/ to the doc folder inside rst |
| 102 | COMMAND ${CMAKE_COMMAND} -E env |
| 103 | ZEPHYR_BUILD=${CMAKE_CURRENT_BINARY_DIR} |
| 104 | ${PYTHON_EXECUTABLE} scripts/extract_content.py ${RST_OUT}/doc samples boards |
Carles Cufi | 2af9a9e | 2018-07-13 15:32:36 +0200 | [diff] [blame] | 105 | WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 106 | ) |
| 107 | |
| 108 | if(WIN32) |
| 109 | set(SEP ;) |
| 110 | else() |
| 111 | set(SEP :) |
| 112 | endif() |
| 113 | |
| 114 | add_custom_target( |
| 115 | kconfig |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 116 | COMMAND ${CMAKE_COMMAND} -E make_directory ${RST_OUT}/doc/reference/kconfig |
| 117 | COMMAND ${CMAKE_COMMAND} -E env |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 118 | PYTHONPATH="${ZEPHYR_BASE}/scripts/kconfig${SEP}$ENV{PYTHONPATH}" |
| 119 | srctree=${ZEPHYR_BASE} |
Sebastian Bøe | 93230a5 | 2018-09-28 13:10:57 +0200 | [diff] [blame^] | 120 | KERNELVERSION=${KERNELVERSION} |
Ulf Magnusson | d0e8752 | 2018-09-05 12:58:05 +0200 | [diff] [blame] | 121 | BOARD_DIR=boards/*/*/ |
| 122 | ARCH=* |
Anas Nashif | 96455d5 | 2018-09-04 14:34:06 -0500 | [diff] [blame] | 123 | SOC_DIR=soc/ |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 124 | SRCARCH=x86 |
Ulf Magnusson | a56be6f | 2018-08-17 22:27:01 +0200 | [diff] [blame] | 125 | ${PYTHON_EXECUTABLE} scripts/genrest.py Kconfig ${RST_OUT}/doc/reference/kconfig/ |
Carles Cufi | 2af9a9e | 2018-07-13 15:32:36 +0200 | [diff] [blame] | 126 | WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 127 | ) |
| 128 | |
| 129 | set(KI_SCRIPT ${ZEPHYR_BASE}/scripts/filter-known-issues.py) |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 130 | set(FIX_TEX_SCRIPT ${ZEPHYR_BASE}/doc/scripts/fix_tex.py) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 131 | set(CONFIG_DIR ${ZEPHYR_BASE}/.known-issues/doc) |
| 132 | |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 133 | # |
| 134 | # HTML section |
| 135 | # |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 136 | add_custom_target( |
| 137 | html |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 138 | COMMAND ${CMAKE_COMMAND} -E env |
| 139 | ZEPHYR_BUILD=${CMAKE_CURRENT_BINARY_DIR} |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 140 | ${SPHINXBUILD} -w ${SPHINX_LOG} -N -t ${DOC_TAG} -b html ${ALLSPHINXOPTS} ${RST_OUT}/doc ${SPHINX_OUTPUT_DIR_HTML} |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 141 | # Merge the Doxygen and Sphinx logs into a single file |
| 142 | COMMAND ${CMAKE_COMMAND} -P ${ZEPHYR_BASE}/cmake/util/fmerge.cmake ${DOC_LOG} ${DOXY_LOG} ${SPHINX_LOG} |
| 143 | COMMAND ${PYTHON_EXECUTABLE} ${KI_SCRIPT} --config-dir ${CONFIG_DIR} --errors ${DOC_WARN} --warnings ${DOC_WARN} ${DOC_LOG} |
Carles Cufi | 2af9a9e | 2018-07-13 15:32:36 +0200 | [diff] [blame] | 144 | WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
Carles Cufi | 60c5540 | 2018-07-15 18:57:01 +0200 | [diff] [blame] | 145 | ${SPHINX_USES_TERMINAL} |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 146 | ) |
Carles Cufi | 7896451 | 2018-07-15 18:49:37 +0200 | [diff] [blame] | 147 | |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 148 | # |
| 149 | # LaTEX section |
| 150 | # |
Daniel Leung | c164c8e | 2018-09-10 17:29:20 -0700 | [diff] [blame] | 151 | add_custom_command( |
| 152 | OUTPUT ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.tex |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 153 | COMMAND ${CMAKE_COMMAND} -E env |
| 154 | ZEPHYR_BUILD=${CMAKE_CURRENT_BINARY_DIR} |
| 155 | ${SPHINXBUILD} -w ${SPHINX_LOG} -N -t ${DOC_TAG} -b latex -t svgconvert ${ALLSPHINXOPTS} ${RST_OUT}/doc ${SPHINX_OUTPUT_DIR_LATEX} |
| 156 | # Merge the Doxygen and Sphinx logs into a single file |
| 157 | COMMAND ${CMAKE_COMMAND} -P ${ZEPHYR_BASE}/cmake/util/fmerge.cmake ${DOC_LOG} ${DOXY_LOG} ${SPHINX_LOG} |
| 158 | COMMAND ${PYTHON_EXECUTABLE} ${KI_SCRIPT} --config-dir ${CONFIG_DIR} --errors ${DOC_WARN} --warnings ${DOC_WARN} ${DOC_LOG} |
| 159 | COMMAND ${PYTHON_EXECUTABLE} ${FIX_TEX_SCRIPT} ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.tex |
| 160 | WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
Carles Cufi | 7599fad | 2018-09-26 11:22:32 +0200 | [diff] [blame] | 161 | ${SPHINX_USES_TERMINAL} |
Daniel Leung | c164c8e | 2018-09-10 17:29:20 -0700 | [diff] [blame] | 162 | ) |
| 163 | |
| 164 | add_custom_target( |
| 165 | latex |
| 166 | DEPENDS ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.tex |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 167 | ) |
| 168 | |
| 169 | # |
| 170 | # PDF section |
| 171 | # |
| 172 | if(NOT ${LATEXMK} STREQUAL LATEXMK-NOTFOUND) |
| 173 | |
| 174 | add_custom_command( |
| 175 | OUTPUT ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.pdf |
| 176 | DEPENDS latexdocs ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.tex |
| 177 | COMMAND ${CMAKE_COMMAND} -E env |
| 178 | LATEXOPTS='-halt-on-error -no-shell-escape' |
| 179 | ${LATEXMK} -quiet -pdf -dvi- -ps- |
| 180 | WORKING_DIRECTORY ${SPHINX_OUTPUT_DIR_LATEX} |
| 181 | ) |
| 182 | |
| 183 | if(NOT DEFINED SPHINX_OUTPUT_DIR) |
| 184 | # Although latexmk allows specifying output directory, |
| 185 | # makeindex fails if one is specified. |
| 186 | # Hence the need of this to copy the PDF file over. |
| 187 | add_custom_command( |
| 188 | OUTPUT ${SPHINX_OUTPUT_DIR_PDF}/zephyr.pdf |
| 189 | COMMAND ${CMAKE_COMMAND} -E make_directory ${SPHINX_OUTPUT_DIR_PDF} |
| 190 | COMMAND ${CMAKE_COMMAND} -E copy ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.pdf ${SPHINX_OUTPUT_DIR_PDF}/zephyr.pdf |
| 191 | DEPENDS ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.pdf |
| 192 | ) |
| 193 | endif() |
| 194 | |
| 195 | add_custom_target( |
| 196 | pdf |
| 197 | DEPENDS ${SPHINX_OUTPUT_DIR_PDF}/zephyr.pdf |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 198 | ) |
| 199 | |
| 200 | endif() |
| 201 | |
| 202 | # |
| 203 | # Dependencies and final targets |
| 204 | # |
Carles Cufi | 7896451 | 2018-07-15 18:49:37 +0200 | [diff] [blame] | 205 | add_dependencies(html content doxy kconfig) |
| 206 | |
| 207 | add_custom_target( |
| 208 | htmldocs |
| 209 | ) |
| 210 | add_dependencies(htmldocs html) |
| 211 | |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 212 | add_dependencies(latex content doxy kconfig) |
| 213 | |
| 214 | add_custom_target( |
| 215 | latexdocs |
| 216 | ) |
| 217 | add_dependencies(latexdocs latex) |
| 218 | |
| 219 | if(NOT ${LATEXMK} STREQUAL LATEXMK-NOTFOUND) |
| 220 | |
| 221 | add_custom_target( |
| 222 | pdfdocs |
Daniel Leung | c164c8e | 2018-09-10 17:29:20 -0700 | [diff] [blame] | 223 | DEPENDS latexdocs pdf |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 224 | ) |
| 225 | add_dependencies(pdfdocs pdf) |
| 226 | |
| 227 | endif() |