mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-06 10:35:43 +00:00
444964e031
Add a new hardware features filter to the board catalog that allows users to filter boards based on their supported hardware capabilities. The features are extracted from the devicetree files and organized by binding type. Key changes: - Extract hardware feature descriptions from devicetree bindings - Add HW_FEATURES_TURBO_MODE option to skip feature generation for faster builds (similar to DT_TURBO_MODE) - Add tag-based UI for filtering boards by hardware features The feature can be disabled for faster documentation builds using -DHW_FEATURES_TURBO_MODE=1 or by using 'make html-fast'. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
41 lines
1.1 KiB
Makefile
41 lines
1.1 KiB
Makefile
# ------------------------------------------------------------------------------
|
|
# Makefile for documentation build
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
BUILDDIR ?= _build
|
|
DOC_TAG ?= development
|
|
SPHINXOPTS ?= -j auto -W --keep-going -T
|
|
SPHINXOPTS_EXTRA ?=
|
|
LATEXMKOPTS ?= -halt-on-error -no-shell-escape
|
|
DT_TURBO_MODE ?= 0
|
|
HW_FEATURES_TURBO_MODE ?= 0
|
|
|
|
# ------------------------------------------------------------------------------
|
|
# Documentation targets
|
|
|
|
.PHONY: configure clean html html-fast html-live html-live-fast latex pdf doxygen
|
|
|
|
html-fast:
|
|
${MAKE} html DT_TURBO_MODE=1 HW_FEATURES_TURBO_MODE=1
|
|
|
|
html-live-fast:
|
|
${MAKE} html-live DT_TURBO_MODE=1 HW_FEATURES_TURBO_MODE=1
|
|
|
|
html html-live latex pdf linkcheck doxygen: configure
|
|
cmake --build ${BUILDDIR} --target $@
|
|
|
|
configure:
|
|
cmake \
|
|
-GNinja \
|
|
-B${BUILDDIR} \
|
|
-S. \
|
|
-DDOC_TAG=${DOC_TAG} \
|
|
-DSPHINXOPTS="${SPHINXOPTS}" \
|
|
-DSPHINXOPTS_EXTRA="${SPHINXOPTS_EXTRA}" \
|
|
-DLATEXMKOPTS="${LATEXMKOPTS}" \
|
|
-DDT_TURBO_MODE=${DT_TURBO_MODE} \
|
|
-DHW_FEATURES_TURBO_MODE=${HW_FEATURES_TURBO_MODE}
|
|
|
|
clean:
|
|
cmake --build ${BUILDDIR} --target clean
|