zephyr/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

pdfdocs:
	mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} pdfdocs
build: add top-level Makefile for docs for docs and everything that is not covered by cmake. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-11-08 09:05:56 +08:00			`#`
			`# Top level makefile for things not covered by cmake`
			`#`

doc: give nicer error if env not set up 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> 2018-09-05 04:03:50 +08:00			`ifndef ZEPHYR_BASE`
			`$(error The ZEPHYR_BASE environment variable must be set)`
			`endif`

doc: Change Makefile and doc for building docs to CMake Now that CMake is supported for building the docs, adapt the instructions to build the documentation to the new mechanism and also adapt the root-level Makefile to support building using CMake. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2018-07-10 19:31:18 +08:00			`BUILDDIR ?= doc/_build`
doc: Makefil: Propagate Make options In order to build with different themes, propagate the theme options through the Makefile to CMake. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 2018-07-13 17:55:54 +08:00			`DOC_TAG ?= development`
			`SPHINXOPTS ?= -q`
build: add top-level Makefile for docs for docs and everything that is not covered by cmake. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2017-11-08 09:05:56 +08:00
			`# Documentation targets`
			`# ---------------------------------------------------------------------------`
			`htmldocs:`
doc: Makefile: Switch to Ninja as a generator Since we only document Ninja as a generator for building the documentation, switch to it for the convenience Makefile provided. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no> 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`
doc: document build target for PDF This adds to the documentation how to build PDF. Signed-off-by: Daniel Leung <daniel.leung@intel.com> 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`