Anas Nashif | 5060ca6 | 2018-12-11 10:33:23 -0500 | [diff] [blame] | 1 | cmake_minimum_required(VERSION 3.13.1) |
Sebastian Bøe | 5748fe1 | 2019-01-04 09:13:07 +0100 | [diff] [blame] | 2 | project(Zephyr-Kernel-Doc LANGUAGES) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 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) |
Carles Cufi | 0698dba | 2018-10-02 10:30:39 +0200 | [diff] [blame] | 13 | find_package(LATEX) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 14 | |
| 15 | find_program( |
| 16 | SPHINXBUILD |
Marc Herbert | a49f9eb | 2019-02-04 15:24:01 -0800 | [diff] [blame] | 17 | NAMES sphinx-build-3 sphinx-build |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 18 | ) |
| 19 | if(${SPHINXBUILD} STREQUAL SPHINXBUILD-NOTFOUND) |
| 20 | message(FATAL_ERROR "The 'sphinx-build' command was not found. Make sure you have Sphinx installed.") |
| 21 | endif() |
| 22 | |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 23 | # Note that this won't force fatal error if latexmk is not found. |
| 24 | # Not having LaTeX tools should not prevent people from generating HTML docs. |
| 25 | find_program( |
| 26 | LATEXMK |
| 27 | latexmk |
| 28 | ) |
| 29 | if(${LATEXMK} STREQUAL LATEXMK-NOTFOUND) |
| 30 | message(WARNING "The 'latexmk' command was not found. Targets to build PDF will not be available.") |
| 31 | endif() |
| 32 | |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 33 | if(NOT DEFINED SPHINXOPTS) |
| 34 | set(SPHINXOPTS -q) |
Carles Cufi | d505ca7 | 2018-07-13 12:37:13 +0200 | [diff] [blame] | 35 | else() |
| 36 | separate_arguments(SPHINXOPTS) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 37 | endif() |
| 38 | |
Carles Cufi | 896a696 | 2018-08-16 13:45:59 +0200 | [diff] [blame] | 39 | if(NOT DEFINED SPHINX_OUTPUT_DIR) |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 40 | set(SPHINX_OUTPUT_DIR_HTML ${CMAKE_CURRENT_BINARY_DIR}/html) |
| 41 | set(SPHINX_OUTPUT_DIR_LATEX ${CMAKE_CURRENT_BINARY_DIR}/latex) |
| 42 | set(SPHINX_OUTPUT_DIR_PDF ${CMAKE_CURRENT_BINARY_DIR}/pdf) |
| 43 | else() |
Marti Bolivar | 2952bf8 | 2018-10-09 13:28:41 -0600 | [diff] [blame] | 44 | # SPHINX_OUTPUT_DIR is used to specify exactly where HTML (or other |
| 45 | # outputs) are placed, so no /html, /latex, /pdf suffixes are needed. |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 46 | set(SPHINX_OUTPUT_DIR_HTML ${SPHINX_OUTPUT_DIR}) |
| 47 | set(SPHINX_OUTPUT_DIR_LATEX ${SPHINX_OUTPUT_DIR}) |
| 48 | set(SPHINX_OUTPUT_DIR_PDF ${SPHINX_OUTPUT_DIR}) |
Carles Cufi | 896a696 | 2018-08-16 13:45:59 +0200 | [diff] [blame] | 49 | endif() |
| 50 | |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 51 | if(NOT DEFINED DOC_TAG) |
| 52 | set(DOC_TAG development) |
| 53 | endif() |
| 54 | |
| 55 | # Internal variables. |
Carles Cufi | 2af9a9e | 2018-07-13 15:32:36 +0200 | [diff] [blame] | 56 | set(ALLSPHINXOPTS -d ${CMAKE_CURRENT_BINARY_DIR}/doctrees ${SPHINXOPTS}) |
Carles Cufi | 60c5540 | 2018-07-15 18:57:01 +0200 | [diff] [blame] | 57 | if("-q" IN_LIST ALLSPHINXOPTS) |
| 58 | set(SPHINX_USES_TERMINAL ) |
| 59 | else() |
| 60 | set(SPHINX_USES_TERMINAL USES_TERMINAL) |
| 61 | endif() |
| 62 | |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 63 | # the i18n builder cannot share the environment and doctrees with the others |
Carles Cufi | d505ca7 | 2018-07-13 12:37:13 +0200 | [diff] [blame] | 64 | set(I18NSPHINXOPTS ${SPHINXOPTS}) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 65 | |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 66 | set(DOXYFILE_IN ${CMAKE_CURRENT_LIST_DIR}/zephyr.doxyfile.in) |
| 67 | set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/zephyr.doxyfile) |
Carles Cufi | 40b63e5 | 2019-02-19 13:47:03 +0100 | [diff] [blame] | 68 | set(DOXY_OUT ${CMAKE_CURRENT_BINARY_DIR}/doxygen) |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 69 | set(RST_OUT ${CMAKE_CURRENT_BINARY_DIR}/rst) |
| 70 | set(DOC_LOG ${CMAKE_CURRENT_BINARY_DIR}/doc.log) |
| 71 | set(DOXY_LOG ${CMAKE_CURRENT_BINARY_DIR}/doxy.log) |
| 72 | set(SPHINX_LOG ${CMAKE_CURRENT_BINARY_DIR}/sphinx.log) |
| 73 | set(DOC_WARN ${CMAKE_CURRENT_BINARY_DIR}/doc.warnings) |
Marti Bolivar | 0913c29 | 2018-10-09 12:42:03 -0600 | [diff] [blame] | 74 | set(CONTENT_OUTPUTS ${CMAKE_CURRENT_BINARY_DIR}/extracted-content.txt) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 75 | |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 76 | configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY) |
Anas Nashif | b8fc4ec | 2019-02-08 21:45:41 -0500 | [diff] [blame] | 77 | file(TOUCH ${CMAKE_CURRENT_BINARY_DIR}/Kconfig.modules) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 78 | |
Marc Herbert | fc64481 | 2019-02-15 10:41:25 -0800 | [diff] [blame^] | 79 | # This command is used to copy all documentation source files from the |
| 80 | # ZEPHYR_BASE/ environment variable into the build directory, |
Marti Bolivar | d7dc113 | 2018-10-16 08:39:35 -0600 | [diff] [blame] | 81 | # |
| 82 | # We need to make copies because Sphinx requires a single |
| 83 | # documentation root directory, but Zephyr's documentation is |
| 84 | # scattered around the tree in samples/, boards/, and doc/. Putting |
| 85 | # them into a single rooted tree in the build directory is a |
| 86 | # workaround for this limitation. |
Marti Bolivar | 0913c29 | 2018-10-09 12:42:03 -0600 | [diff] [blame] | 87 | set(EXTRACT_CONTENT_COMMAND |
| 88 | ${CMAKE_COMMAND} -E env |
| 89 | ${PYTHON_EXECUTABLE} scripts/extract_content.py |
Marti Bolivar | 0913c29 | 2018-10-09 12:42:03 -0600 | [diff] [blame] | 90 | # Ignore any files in the output directory. |
| 91 | --ignore ${CMAKE_CURRENT_BINARY_DIR} |
| 92 | # Copy all files in doc to the rst folder. |
| 93 | "*:doc:${RST_OUT}" |
Marti Bolivar | d7dc113 | 2018-10-16 08:39:35 -0600 | [diff] [blame] | 94 | # We want to copy the .rst files in samples/ and boards/ to the rst |
| 95 | # folder, and also the doc folder inside rst. |
Marti Bolivar | 0913c29 | 2018-10-09 12:42:03 -0600 | [diff] [blame] | 96 | # |
| 97 | # Some files refer to items in samples/ and boards/ relative to |
| 98 | # their actual position in the Zephyr tree. For example, in |
| 99 | # subsystems/sensor.rst: |
| 100 | # |
| 101 | # .. literalinclude:: ../../samples/sensor/mcp9808/src/main.c |
| 102 | # |
Marti Bolivar | d7dc113 | 2018-10-16 08:39:35 -0600 | [diff] [blame] | 103 | # The additional copy is a hackaround so these references work. |
Marti Bolivar | 0913c29 | 2018-10-09 12:42:03 -0600 | [diff] [blame] | 104 | "*.rst:samples:${RST_OUT}" "*.rst:boards:${RST_OUT}" |
| 105 | "*.rst:samples:${RST_OUT}/doc" "*.rst:boards:${RST_OUT}/doc") |
| 106 | |
Carles Cufi | 15fbf70 | 2018-12-06 12:21:48 +0100 | [diff] [blame] | 107 | add_custom_target( |
| 108 | content |
| 109 | # Copy all files in doc/ to the rst folder |
Marti Bolivar | 0913c29 | 2018-10-09 12:42:03 -0600 | [diff] [blame] | 110 | COMMAND ${EXTRACT_CONTENT_COMMAND} |
| 111 | WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
Marc Herbert | fc64481 | 2019-02-15 10:41:25 -0800 | [diff] [blame^] | 112 | COMMENT "Copying files to ${RST_OUT}" |
Carles Cufi | 15fbf70 | 2018-12-06 12:21:48 +0100 | [diff] [blame] | 113 | ) |
Marti Bolivar | 0913c29 | 2018-10-09 12:42:03 -0600 | [diff] [blame] | 114 | |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 115 | set(ARGS ${DOXYFILE_OUT}) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 116 | |
| 117 | add_custom_target( |
| 118 | doxy |
| 119 | COMMAND ${CMAKE_COMMAND} |
| 120 | -DCOMMAND=${DOXYGEN_EXECUTABLE} |
| 121 | -DARGS="${ARGS}" |
| 122 | -DOUTPUT_FILE=${DOXY_LOG} |
| 123 | -DERROR_FILE=${DOXY_LOG} |
Carles Cufi | 2af9a9e | 2018-07-13 15:32:36 +0200 | [diff] [blame] | 124 | -DWORKING_DIRECTORY=${CMAKE_CURRENT_LIST_DIR} |
Carles Cufi | 45d58a7 | 2018-07-12 17:34:29 +0200 | [diff] [blame] | 125 | -P ${ZEPHYR_BASE}/cmake/util/execute_process.cmake |
Marc Herbert | fc64481 | 2019-02-15 10:41:25 -0800 | [diff] [blame^] | 126 | COMMENT "Running ${DOXYGEN_EXECUTABLE}" |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 127 | ) |
| 128 | |
Marc Herbert | 5284231 | 2019-02-07 13:39:59 -0800 | [diff] [blame] | 129 | # Doxygen doesn't support incremental builds. |
| 130 | # It could be ok because it's pretty fast. |
| 131 | # But it's not because it has a cascade effect on sphinx: |
| 132 | # https://sourceforge.net/p/doxygen/mailman/message/36580807/ |
| 133 | # For now this optimization speeds-up non-doxygen documentation work |
| 134 | # only (by one order of magnitude). |
| 135 | add_custom_target( |
| 136 | doxy_real_modified_times |
| 137 | COMMAND ${CMAKE_COMMAND} -E env |
| 138 | ${PYTHON_EXECUTABLE} scripts/restore_modification_times.py |
Marc Herbert | fc64481 | 2019-02-15 10:41:25 -0800 | [diff] [blame^] | 139 | --loglevel WARN ${DOXY_OUT}/xml |
Marc Herbert | 5284231 | 2019-02-07 13:39:59 -0800 | [diff] [blame] | 140 | WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
| 141 | ) |
| 142 | |
| 143 | add_dependencies(doxy_real_modified_times doxy) |
| 144 | |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 145 | add_custom_target( |
| 146 | pristine |
| 147 | COMMAND ${CMAKE_COMMAND} -P ${ZEPHYR_BASE}/cmake/pristine.cmake |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 148 | ) |
| 149 | |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 150 | if(WIN32) |
| 151 | set(SEP ;) |
| 152 | else() |
| 153 | set(SEP :) |
| 154 | endif() |
| 155 | |
| 156 | add_custom_target( |
| 157 | kconfig |
Carles Cufi | e182dbc | 2018-07-16 19:05:05 +0200 | [diff] [blame] | 158 | COMMAND ${CMAKE_COMMAND} -E make_directory ${RST_OUT}/doc/reference/kconfig |
| 159 | COMMAND ${CMAKE_COMMAND} -E env |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 160 | PYTHONPATH="${ZEPHYR_BASE}/scripts/kconfig${SEP}$ENV{PYTHONPATH}" |
| 161 | srctree=${ZEPHYR_BASE} |
Sebastian Bøe | 93230a5 | 2018-09-28 13:10:57 +0200 | [diff] [blame] | 162 | KERNELVERSION=${KERNELVERSION} |
Ulf Magnusson | d0e8752 | 2018-09-05 12:58:05 +0200 | [diff] [blame] | 163 | BOARD_DIR=boards/*/*/ |
| 164 | ARCH=* |
Klaus Petersen | c66cb76 | 2018-11-15 10:37:46 +0100 | [diff] [blame] | 165 | ARCH_DIR=arch/ |
Anas Nashif | 96455d5 | 2018-09-04 14:34:06 -0500 | [diff] [blame] | 166 | SOC_DIR=soc/ |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 167 | SRCARCH=x86 |
Anas Nashif | b8fc4ec | 2019-02-08 21:45:41 -0500 | [diff] [blame] | 168 | PROJECT_BINARY_DIR=${CMAKE_CURRENT_BINARY_DIR} |
Sebastian Bøe | 1ca1075 | 2019-02-12 12:05:36 +0100 | [diff] [blame] | 169 | GENERATED_DTS_BOARD_CONF=not_applicable |
Anas Nashif | 940a931 | 2019-01-21 13:58:05 -0500 | [diff] [blame] | 170 | KCONFIG_TURBO_MODE=${KCONFIG_TURBO_MODE} |
Carles Cufi | fa26ef0 | 2019-01-30 17:54:21 +0100 | [diff] [blame] | 171 | KCONFIG_DOC_MODE=1 |
Ulf Magnusson | a56be6f | 2018-08-17 22:27:01 +0200 | [diff] [blame] | 172 | ${PYTHON_EXECUTABLE} scripts/genrest.py Kconfig ${RST_OUT}/doc/reference/kconfig/ |
Carles Cufi | 2af9a9e | 2018-07-13 15:32:36 +0200 | [diff] [blame] | 173 | WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
Marc Herbert | fc64481 | 2019-02-15 10:41:25 -0800 | [diff] [blame^] | 174 | COMMENT "Running genrest.py Kconfig ${RST_OUT}/doc/reference/kconfig/" |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 175 | ) |
| 176 | |
| 177 | set(KI_SCRIPT ${ZEPHYR_BASE}/scripts/filter-known-issues.py) |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 178 | set(FIX_TEX_SCRIPT ${ZEPHYR_BASE}/doc/scripts/fix_tex.py) |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 179 | set(CONFIG_DIR ${ZEPHYR_BASE}/.known-issues/doc) |
| 180 | |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 181 | # |
| 182 | # HTML section |
| 183 | # |
Marti Bolivar | d9f512c | 2018-10-09 14:24:34 -0600 | [diff] [blame] | 184 | set(SPHINX_BUILD_HTML_COMMAND |
| 185 | ${CMAKE_COMMAND} -E env |
| 186 | ZEPHYR_BUILD=${CMAKE_CURRENT_BINARY_DIR} |
| 187 | ${SPHINXBUILD} -w ${SPHINX_LOG} -N -t ${DOC_TAG} -b html ${ALLSPHINXOPTS} ${RST_OUT}/doc ${SPHINX_OUTPUT_DIR_HTML}) |
| 188 | |
| 189 | # The sphinx-html target is provided as a convenience for incremental |
| 190 | # re-builds of content files without regenerating the entire docs |
| 191 | # pipeline. It can be significantly faster than re-running the full |
| 192 | # HTML build, but it has no idea if Doxygen, Kconfig, etc. need to be |
| 193 | # regenerated. Use with caution. |
| 194 | add_custom_target( |
| 195 | sphinx-html |
| 196 | COMMAND ${SPHINX_BUILD_HTML_COMMAND} |
| 197 | DEPENDS ${EXTRACT_CONTENT_OUTPUTS} |
| 198 | COMMENT "Just re-generating HTML (USE WITH CAUTION)" |
| 199 | USES_TERMINAL |
| 200 | ) |
| 201 | |
Marc Herbert | fc64481 | 2019-02-15 10:41:25 -0800 | [diff] [blame^] | 202 | # "breathe", the sphinx plugin that parses XML output from doxygen, has |
| 203 | # an "everything on everything" dependency issue reported at: |
| 204 | # https://github.com/michaeljones/breathe/issues/420 In other words |
| 205 | # changing 1 source file costs the same build time than changing all |
| 206 | # source files. breathe is fortunately smart enough not to run at all |
| 207 | # when *nothing* has changed. |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 208 | add_custom_target( |
| 209 | html |
Marti Bolivar | d9f512c | 2018-10-09 14:24:34 -0600 | [diff] [blame] | 210 | COMMAND ${SPHINX_BUILD_HTML_COMMAND} |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 211 | # Merge the Doxygen and Sphinx logs into a single file |
| 212 | COMMAND ${CMAKE_COMMAND} -P ${ZEPHYR_BASE}/cmake/util/fmerge.cmake ${DOC_LOG} ${DOXY_LOG} ${SPHINX_LOG} |
| 213 | 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] | 214 | WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
Marc Herbert | fc64481 | 2019-02-15 10:41:25 -0800 | [diff] [blame^] | 215 | COMMENT "Generating HTML documentation with ${SPHINXBUILD} ${SPHINXOPTS}" |
Carles Cufi | 60c5540 | 2018-07-15 18:57:01 +0200 | [diff] [blame] | 216 | ${SPHINX_USES_TERMINAL} |
Carles Cufi | ae69934 | 2018-07-09 14:12:17 +0200 | [diff] [blame] | 217 | ) |
Carles Cufi | 7896451 | 2018-07-15 18:49:37 +0200 | [diff] [blame] | 218 | |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 219 | # |
| 220 | # LaTEX section |
| 221 | # |
Marti Bolivar | d9f512c | 2018-10-09 14:24:34 -0600 | [diff] [blame] | 222 | set(SPHINX_BUILD_LATEX_COMMAND |
| 223 | ${CMAKE_COMMAND} -E env |
| 224 | ZEPHYR_BUILD=${CMAKE_CURRENT_BINARY_DIR} |
| 225 | ${SPHINXBUILD} -w ${SPHINX_LOG} -N -t ${DOC_TAG} -b latex -t svgconvert ${ALLSPHINXOPTS} ${RST_OUT}/doc ${SPHINX_OUTPUT_DIR_LATEX}) |
| 226 | |
| 227 | # The sphinx-latex target works similarly to sphinx-html, and carries |
| 228 | # the same warnings. |
| 229 | add_custom_target( |
| 230 | sphinx-latex |
| 231 | COMMAND ${SPHINX_BUILD_LATEX_COMMAND} |
| 232 | DEPENDS ${EXTRACT_CONTENT_OUTPUTS} |
| 233 | COMMENT "Just re-generating LaTeX (USE WITH CAUTION)" |
| 234 | USES_TERMINAL |
| 235 | ) |
| 236 | |
Daniel Leung | c164c8e | 2018-09-10 17:29:20 -0700 | [diff] [blame] | 237 | add_custom_command( |
| 238 | OUTPUT ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.tex |
Marti Bolivar | d9f512c | 2018-10-09 14:24:34 -0600 | [diff] [blame] | 239 | COMMAND ${SPHINX_BUILD_LATEX_COMMAND} |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 240 | # Merge the Doxygen and Sphinx logs into a single file |
| 241 | COMMAND ${CMAKE_COMMAND} -P ${ZEPHYR_BASE}/cmake/util/fmerge.cmake ${DOC_LOG} ${DOXY_LOG} ${SPHINX_LOG} |
| 242 | COMMAND ${PYTHON_EXECUTABLE} ${KI_SCRIPT} --config-dir ${CONFIG_DIR} --errors ${DOC_WARN} --warnings ${DOC_WARN} ${DOC_LOG} |
| 243 | COMMAND ${PYTHON_EXECUTABLE} ${FIX_TEX_SCRIPT} ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.tex |
| 244 | WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
Marti Bolivar | d9f512c | 2018-10-09 14:24:34 -0600 | [diff] [blame] | 245 | COMMENT "Generating LaTeX documentation" |
Carles Cufi | 7599fad | 2018-09-26 11:22:32 +0200 | [diff] [blame] | 246 | ${SPHINX_USES_TERMINAL} |
Daniel Leung | c164c8e | 2018-09-10 17:29:20 -0700 | [diff] [blame] | 247 | ) |
| 248 | |
| 249 | add_custom_target( |
| 250 | latex |
| 251 | DEPENDS ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.tex |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 252 | ) |
| 253 | |
| 254 | # |
| 255 | # PDF section |
| 256 | # |
| 257 | if(NOT ${LATEXMK} STREQUAL LATEXMK-NOTFOUND) |
| 258 | |
| 259 | add_custom_command( |
| 260 | OUTPUT ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.pdf |
| 261 | DEPENDS latexdocs ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.tex |
| 262 | COMMAND ${CMAKE_COMMAND} -E env |
Carles Cufi | 0698dba | 2018-10-02 10:30:39 +0200 | [diff] [blame] | 263 | LATEXOPTS="-halt-on-error -no-shell-escape" |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 264 | ${LATEXMK} -quiet -pdf -dvi- -ps- |
| 265 | WORKING_DIRECTORY ${SPHINX_OUTPUT_DIR_LATEX} |
Marti Bolivar | d9f512c | 2018-10-09 14:24:34 -0600 | [diff] [blame] | 266 | COMMENT "Generating PDF documentation" |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 267 | ) |
| 268 | |
| 269 | if(NOT DEFINED SPHINX_OUTPUT_DIR) |
| 270 | # Although latexmk allows specifying output directory, |
| 271 | # makeindex fails if one is specified. |
| 272 | # Hence the need of this to copy the PDF file over. |
| 273 | add_custom_command( |
| 274 | OUTPUT ${SPHINX_OUTPUT_DIR_PDF}/zephyr.pdf |
| 275 | COMMAND ${CMAKE_COMMAND} -E make_directory ${SPHINX_OUTPUT_DIR_PDF} |
| 276 | COMMAND ${CMAKE_COMMAND} -E copy ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.pdf ${SPHINX_OUTPUT_DIR_PDF}/zephyr.pdf |
| 277 | DEPENDS ${SPHINX_OUTPUT_DIR_LATEX}/zephyr.pdf |
| 278 | ) |
| 279 | endif() |
| 280 | |
| 281 | add_custom_target( |
| 282 | pdf |
| 283 | DEPENDS ${SPHINX_OUTPUT_DIR_PDF}/zephyr.pdf |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 284 | ) |
| 285 | |
| 286 | endif() |
| 287 | |
| 288 | # |
| 289 | # Dependencies and final targets |
| 290 | # |
Marc Herbert | 5284231 | 2019-02-07 13:39:59 -0800 | [diff] [blame] | 291 | add_dependencies(html content doxy_real_modified_times kconfig) |
Carles Cufi | 7896451 | 2018-07-15 18:49:37 +0200 | [diff] [blame] | 292 | |
| 293 | add_custom_target( |
| 294 | htmldocs |
| 295 | ) |
| 296 | add_dependencies(htmldocs html) |
| 297 | |
Marc Herbert | 5284231 | 2019-02-07 13:39:59 -0800 | [diff] [blame] | 298 | add_dependencies(latex content doxy_real_modified_times kconfig) |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 299 | |
| 300 | add_custom_target( |
| 301 | latexdocs |
| 302 | ) |
| 303 | add_dependencies(latexdocs latex) |
| 304 | |
| 305 | if(NOT ${LATEXMK} STREQUAL LATEXMK-NOTFOUND) |
| 306 | |
| 307 | add_custom_target( |
| 308 | pdfdocs |
Daniel Leung | c164c8e | 2018-09-10 17:29:20 -0700 | [diff] [blame] | 309 | DEPENDS latexdocs pdf |
Daniel Leung | 9945e7f | 2018-08-23 11:11:11 -0700 | [diff] [blame] | 310 | ) |
| 311 | add_dependencies(pdfdocs pdf) |
| 312 | |
| 313 | endif() |