d34c116505
Top-level Makefile is for documentation build convenience, so make it a bit more convenient by adding a make clean target (sometimes needed when to do a clean doc build when changes are made). Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
26 lines
809 B
Makefile
26 lines
809 B
Makefile
#
|
|
# Top level makefile for documentation build
|
|
#
|
|
|
|
ifndef ZEPHYR_BASE
|
|
$(error The ZEPHYR_BASE environment variable must be set)
|
|
endif
|
|
|
|
BUILDDIR ?= doc/_build
|
|
DOC_TAG ?= development
|
|
SPHINXOPTS ?= -q
|
|
|
|
# Documentation targets
|
|
# ---------------------------------------------------------------------------
|
|
clean:
|
|
rm -rf ${BUILDDIR}
|
|
|
|
htmldocs:
|
|
mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs
|
|
|
|
htmldocs-fast:
|
|
mkdir -p ${BUILDDIR} && cmake -GNinja -DKCONFIG_TURBO_MODE=1 -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs
|
|
|
|
pdfdocs:
|
|
mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} pdfdocs
|