blob: dad3b6cbeebcf09a081a7683b89d5d942413da3e [file] [log] [blame]
Anas Nashifdf5d7d72017-11-07 20:05:56 -05001#
David B. Kinderd34c1162019-02-05 09:53:16 -08002# Top level makefile for documentation build
Anas Nashifdf5d7d72017-11-07 20:05:56 -05003#
4
Carles Cufi7480f172018-07-10 13:31:18 +02005BUILDDIR ?= doc/_build
Carles Cufib3d2de72018-07-13 11:55:54 +02006DOC_TAG ?= development
7SPHINXOPTS ?= -q
Anas Nashifdf5d7d72017-11-07 20:05:56 -05008
9# Documentation targets
10# ---------------------------------------------------------------------------
David B. Kinderd34c1162019-02-05 09:53:16 -080011clean:
12 rm -rf ${BUILDDIR}
13
Anas Nashifdf5d7d72017-11-07 20:05:56 -050014htmldocs:
Carles Cufif84caef2018-07-19 13:47:45 +020015 mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs
Daniel Leung1d88e862018-09-10 17:27:13 -070016
Anas Nashif940a9312019-01-21 13:58:05 -050017htmldocs-fast:
18 mkdir -p ${BUILDDIR} && cmake -GNinja -DKCONFIG_TURBO_MODE=1 -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs
19
Daniel Leung1d88e862018-09-10 17:27:13 -070020pdfdocs:
21 mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} pdfdocs
Anas Nashif0a58fe82020-04-10 08:07:55 -040022
23doxygen:
24 mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} doxygen