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
|
|
|
#
|
|
|
|
|
|
2018-07-10 19:31:18 +08:00
|
|
|
BUILDDIR ?= doc/_build
|
2018-07-13 17:55:54 +08:00
|
|
|
DOC_TAG ?= development
|
|
|
|
|
SPHINXOPTS ?= -q
|
2017-11-08 09:05:56 +08:00
|
|
|
|
|
|
|
|
# Documentation targets
|
|
|
|
|
# ---------------------------------------------------------------------------
|
2019-02-06 01:53:16 +08:00
|
|
|
clean:
|
|
|
|
|
rm -rf ${BUILDDIR}
|
|
|
|
|
|
2017-11-08 09:05:56 +08:00
|
|
|
htmldocs:
|
2018-07-19 19:47:45 +08:00
|
|
|
mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs
|
2018-09-11 08:27:13 +08:00
|
|
|
|
2019-01-22 02:58:05 +08:00
|
|
|
htmldocs-fast:
|
|
|
|
|
mkdir -p ${BUILDDIR} && cmake -GNinja -DKCONFIG_TURBO_MODE=1 -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs
|
|
|
|
|
|
2018-09-11 08:27:13 +08:00
|
|
|
pdfdocs:
|
|
|
|
|
mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} pdfdocs
|
2020-04-10 20:07:55 +08:00
|
|
|
|
|
|
|
|
doxygen:
|
|
|
|
|
mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} doxygen
|
