940a931b08
Building the documentation for all the Kconfig options significantly
adds to the total doc build time. When making and testing major changes
to the documentation, we provide an option to temporarily stub-out
the auto-generated configuration documentation so the doc build process
runs much faster.
To enable this mode, set the following option when invoking cmake
-DKCONFIG_TURBO_MODE=1
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
23 lines
789 B
Makefile
23 lines
789 B
Makefile
#
|
|
# Top level makefile for things not covered by cmake
|
|
#
|
|
|
|
ifndef ZEPHYR_BASE
|
|
$(error The ZEPHYR_BASE environment variable must be set)
|
|
endif
|
|
|
|
BUILDDIR ?= doc/_build
|
|
DOC_TAG ?= development
|
|
SPHINXOPTS ?= -q
|
|
|
|
# Documentation targets
|
|
# ---------------------------------------------------------------------------
|
|
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
|