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
12HW_FEATURES_VENDOR_FILTER ?=
13
14# ------------------------------------------------------------------------------
15# Documentation targets
16
17.PHONY: configure clean html html-fast html-live html-live-fast latex pdf doxygen
18
19html-fast:
20	${MAKE} html DT_TURBO_MODE=1 HW_FEATURES_TURBO_MODE=1
21
22html-live-fast:
23	${MAKE} html-live DT_TURBO_MODE=1 HW_FEATURES_TURBO_MODE=1
24
25html html-live latex pdf linkcheck doxygen: configure
26	cmake --build ${BUILDDIR} --target $@
27
28configure:
29	cmake \
30		-GNinja \
31		-B${BUILDDIR} \
32		-S. \
33		-DDOC_TAG=${DOC_TAG} \
34		-DSPHINXOPTS="${SPHINXOPTS}" \
35		-DSPHINXOPTS_EXTRA="${SPHINXOPTS_EXTRA}" \
36		-DLATEXMKOPTS="${LATEXMKOPTS}" \
37		-DDT_TURBO_MODE=${DT_TURBO_MODE} \
38		-DHW_FEATURES_TURBO_MODE=${HW_FEATURES_TURBO_MODE} \
39		-DHW_FEATURES_VENDOR_FILTER=${HW_FEATURES_VENDOR_FILTER}
40
41clean:
42	cmake --build ${BUILDDIR} --target clean
43