2021-06-17 05:49:41 +08:00
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
|
# Makefile for documentation build
|
|
|
|
|
# SPDX-License-Identifier: Apache-2.0
|
2017-11-08 09:05:56 +08:00
|
|
|
|
2021-03-26 03:45:41 +08:00
|
|
|
BUILDDIR ?= _build
|
2018-07-13 17:55:54 +08:00
|
|
|
DOC_TAG ?= development
|
2023-07-13 18:01:42 +08:00
|
|
|
SPHINXOPTS ?= -j auto -W --keep-going -T
|
|
|
|
|
SPHINXOPTS_EXTRA ?=
|
2021-07-26 18:31:40 +08:00
|
|
|
LATEXMKOPTS ?= -halt-on-error -no-shell-escape
|
2022-02-03 03:09:01 +08:00
|
|
|
DT_TURBO_MODE ?= 0
|
2017-11-08 09:05:56 +08:00
|
|
|
|
2021-06-17 05:49:41 +08:00
|
|
|
# ------------------------------------------------------------------------------
|
2017-11-08 09:05:56 +08:00
|
|
|
# Documentation targets
|
2021-02-09 06:11:51 +08:00
|
|
|
|
2024-05-11 10:07:11 +08:00
|
|
|
.PHONY: configure clean html html-fast html-live html-live-fast latex pdf doxygen
|
2019-02-06 01:53:16 +08:00
|
|
|
|
2021-06-17 05:49:41 +08:00
|
|
|
html-fast:
|
2022-01-12 20:41:15 +08:00
|
|
|
${MAKE} html DT_TURBO_MODE=1
|
2021-01-09 06:31:05 +08:00
|
|
|
|
2024-05-11 10:07:11 +08:00
|
|
|
html-live-fast:
|
|
|
|
|
${MAKE} html-live DT_TURBO_MODE=1
|
|
|
|
|
|
|
|
|
|
html html-live latex pdf linkcheck doxygen: configure
|
2021-06-17 05:49:41 +08:00
|
|
|
cmake --build ${BUILDDIR} --target $@
|
2019-01-22 02:58:05 +08:00
|
|
|
|
2021-01-09 06:31:05 +08:00
|
|
|
configure:
|
2021-06-17 05:49:41 +08:00
|
|
|
cmake \
|
|
|
|
|
-GNinja \
|
|
|
|
|
-B${BUILDDIR} \
|
|
|
|
|
-S. \
|
|
|
|
|
-DDOC_TAG=${DOC_TAG} \
|
2021-05-13 00:23:33 +08:00
|
|
|
-DSPHINXOPTS="${SPHINXOPTS}" \
|
2023-07-13 18:01:42 +08:00
|
|
|
-DSPHINXOPTS_EXTRA="${SPHINXOPTS_EXTRA}" \
|
2021-07-26 18:31:40 +08:00
|
|
|
-DLATEXMKOPTS="${LATEXMKOPTS}" \
|
2022-02-03 03:09:01 +08:00
|
|
|
-DDT_TURBO_MODE=${DT_TURBO_MODE}
|
2020-04-10 20:07:55 +08:00
|
|
|
|
2021-02-09 06:11:51 +08:00
|
|
|
clean:
|
2021-06-17 05:49:41 +08:00
|
|
|
cmake --build ${BUILDDIR} --target clean
|
