If one forgets to source the zephyr-env.sh script before starting a doc build (using the top-level Makefile), a long screenful of error messages go by and you can miss what the actual problem is. Check if ZEPHYR_BASE is not set and give a nice short error message. (Updated to a more generic error message in anticipation of #9801 deprecating use of zephyr-env.sh) Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
17 lines
459 B
Makefile
17 lines
459 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
|