2017-11-08 09:05:56 +08:00
|
|
|
#
|
2019-02-06 01:53:16 +08:00
|
|
|
# Top level makefile for documentation build
|
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
|
2021-05-13 00:23:33 +08:00
|
|
|
SPHINXOPTS ?= -j auto
|
2021-01-09 06:31:05 +08:00
|
|
|
KCONFIG_TURBO_MODE ?= 0
|
2017-11-08 09:05:56 +08:00
|
|
|
|
|
|
|
|
# Documentation targets
|
|
|
|
|
# ---------------------------------------------------------------------------
|
2021-02-09 06:11:51 +08:00
|
|
|
|
|
|
|
|
.PHONY: clean htmldocs htmldocs-fast pdfdocs doxygen
|
2019-02-06 01:53:16 +08:00
|
|
|
|
2019-01-22 02:58:05 +08:00
|
|
|
htmldocs-fast:
|
2021-01-09 06:31:05 +08:00
|
|
|
${MAKE} htmldocs KCONFIG_TURBO_MODE=1
|
|
|
|
|
|
|
|
|
|
htmldocs pdfdocs doxygen: configure
|
|
|
|
|
cmake --build ${BUILDDIR} -- $@ # -v # VERBOSE=1
|
2019-01-22 02:58:05 +08:00
|
|
|
|
2021-01-09 06:31:05 +08:00
|
|
|
# Run CMake every time cause it's quick and re-configures TURBO_MODE if
|
|
|
|
|
# needed
|
|
|
|
|
.PHONY: configure
|
|
|
|
|
configure:
|
2021-03-26 03:45:41 +08:00
|
|
|
cmake -GNinja -B${BUILDDIR} -S. -DDOC_TAG=${DOC_TAG} \
|
2021-05-13 00:23:33 +08:00
|
|
|
-DSPHINXOPTS="${SPHINXOPTS}" \
|
2021-01-09 06:31:05 +08:00
|
|
|
-DKCONFIG_TURBO_MODE=${KCONFIG_TURBO_MODE}
|
2020-04-10 20:07:55 +08:00
|
|
|
|
2021-02-09 06:11:51 +08:00
|
|
|
clean:
|
|
|
|
|
rm -rf ${BUILDDIR}
|
