1# ------------------------------------------------------------------------------
2# Makefile for documentation build
3# SPDX-License-Identifier: Apache-2.0
4
5BUILDDIR ?= _build
6DOC_TAG ?= development
7SPHINXOPTS ?= -j auto -W --keep-going -T
8SPHINXOPTS_EXTRA ?=
9LATEXMKOPTS ?= -halt-on-error -no-shell-escape
10DT_TURBO_MODE ?= 0
11HW_FEATURES_TURBO_MODE ?= 0
12
13# ------------------------------------------------------------------------------
14# Documentation targets
15
16.PHONY: configure clean html html-fast html-live html-live-fast latex pdf doxygen
17
18html-fast:
19	${MAKE} html DT_TURBO_MODE=1 HW_FEATURES_TURBO_MODE=1
20
21html-live-fast:
22	${MAKE} html-live DT_TURBO_MODE=1 HW_FEATURES_TURBO_MODE=1
23
24html html-live latex pdf linkcheck doxygen: configure
25	cmake --build ${BUILDDIR} --target $@
26
27configure:
28	cmake \
29		-GNinja \
30		-B${BUILDDIR} \
31		-S. \
32		-DDOC_TAG=${DOC_TAG} \
33		-DSPHINXOPTS="${SPHINXOPTS}" \
34		-DSPHINXOPTS_EXTRA="${SPHINXOPTS_EXTRA}" \
35		-DLATEXMKOPTS="${LATEXMKOPTS}" \
36		-DDT_TURBO_MODE=${DT_TURBO_MODE} \
37		-DHW_FEATURES_TURBO_MODE=${HW_FEATURES_TURBO_MODE}
38
39clean:
40	cmake --build ${BUILDDIR} --target clean
41