Lines Matching +full:doxygen +full:-
1 # SPDX-License-Identifier: Apache-2.0
4 project(Zephyr-Kernel-Doc LANGUAGES)
12 #-------------------------------------------------------------------------------
15 set(SPHINXOPTS "-j auto -W --keep-going -T" CACHE STRING "Default Sphinx Options")
17 set(LATEXMKOPTS "-halt-on-error -no-shell-escape" CACHE STRING "Default latexmk options")
26 #-------------------------------------------------------------------------------
29 find_package(Doxygen REQUIRED dot)
31 find_program(SPHINXBUILD sphinx-build)
33 message(FATAL_ERROR "The 'sphinx-build' command was not found")
35 find_program(SPHINXAUTOBUILD sphinx-autobuild)
43 #-------------------------------------------------------------------------------
56 message(FATAL_ERROR "Zephyr Doxygen overlay $ENV{ZEPHYR_DOXYGEN_OVERLAY} does not exist!")
76 #-------------------------------------------------------------------------------
84 # - Target 1 named: `<name>`
85 # - Target 2 named: `<name>-nodeps`
88 # This is useful to, e.g. re-run the Sphinx build without dependencies such as
93 add_custom_target(${name}-nodeps ${ARGN})
96 #-------------------------------------------------------------------------------
97 # Doxygen (standalone)
99 set(DOXY_OUT ${CMAKE_CURRENT_BINARY_DIR}/doxygen)
107 doxygen target
110 COMMENT "Running Doxygen..."
114 doxygen
119 #-------------------------------------------------------------------------------
126 list(APPEND DTS_ARGS --dts-root ${root})
130 list(APPEND DTS_ARGS --turbo-mode)
135 COMMAND ${CMAKE_COMMAND} -E env
136 PYTHONPATH=${ZEPHYR_BASE}/scripts/dts/python-devicetree/src${SEP}$ENV{PYTHONPATH}
139 --vendor-prefixes ${ZEPHYR_BASE}/dts/bindings/vendor-prefixes.txt
149 #-------------------------------------------------------------------------------
154 COMMAND ${CMAKE_COMMAND} -E env ${SPHINX_ENV} OUTPUT_DIR=${DOCS_HTML_DIR}
156 -b html
157 -c ${DOCS_CFG_DIR}
158 -d ${DOCS_DOCTREE_DIR}
159 -w ${DOCS_BUILD_DIR}/html.log
160 -t ${DOC_TAG}
170 html html-nodeps
177 #-------------------------------------------------------------------------------
178 # html-live
181 html-live
182 COMMAND ${CMAKE_COMMAND} -E env ${SPHINX_ENV}
184 --watch ${DOCS_CFG_DIR}
185 --ignore ${DOCS_BUILD_DIR}
186 -b html
187 -c ${DOCS_CFG_DIR}
188 -d ${DOCS_DOCTREE_DIR}
189 -w ${DOCS_BUILD_DIR}/html.log
190 -t ${DOC_TAG}
200 html-live html-live-nodeps
205 add_dependencies(html-live devicetree)
206 #-------------------------------------------------------------------------------
211 COMMAND ${CMAKE_COMMAND} -E env ${SPHINX_ENV} OUTPUT_DIR=${DOCS_LATEX_DIR}
213 -b latex
214 -c ${DOCS_CFG_DIR}
215 -d ${DOCS_DOCTREE_DIR}
216 -w ${DOCS_BUILD_DIR}/latex.log
217 -t ${DOC_TAG}
218 -t convertimages
228 latex latex-nodeps
248 COMMAND ${CMAKE_COMMAND} -E env LATEXMKOPTS="${LATEXMKOPTS}"
258 #-------------------------------------------------------------------------------
263 COMMAND ${CMAKE_COMMAND} -E env ${SPHINX_ENV} OUTPUT_DIR=${DOCS_LINKCHECK_DIR}
265 -b linkcheck
266 -c ${DOCS_CFG_DIR}
267 -d ${DOCS_DOCTREE_DIR}
268 -w ${DOCS_BUILD_DIR}/linkcheck.log
269 -t ${DOC_TAG}
279 linkcheck linkcheck-nodeps
286 #-------------------------------------------------------------------------------
291 COMMAND ${CMAKE_COMMAND} -P ${ZEPHYR_BASE}/cmake/pristine.cmake