Skip to content

Commit 91c8ffa

Browse files
ulfalizercarlescufi
authored andcommitted
kconfig: doc: Split up symbol reference by path
Use --modules to split the Kconfig reference up by where symbols are defined. See the argparse docstring for --modules in doc/scripts/genrest.py. Not sure what the best way to split things up is, so feedback would be appreciated. I just pulled out some top-level directories. It could always be tweaked later. If a symbol is defined in more than one module (by being defined in multiple locations), it appears on multiple index pages. To build the documentation, do $ mkdir doc/b && cd doc/b $ cmake -GNinja .. $ ninja htmldocs (output in html/reference/kconfig/index.html) Signed-off-by: Ulf Magnusson <[email protected]>
1 parent 5492f2f commit 91c8ffa

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

doc/CMakeLists.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,15 @@ add_custom_target(
205205
KCONFIG_WARN_UNDEF=y
206206
KCONFIG_TURBO_MODE=${KCONFIG_TURBO_MODE}
207207
KCONFIG_DOC_MODE=1
208-
${PYTHON_EXECUTABLE} scripts/genrest.py ${RST_OUT}/doc/reference/kconfig/
208+
${PYTHON_EXECUTABLE} scripts/genrest.py ${RST_OUT}/doc/reference/kconfig/
209+
--keep-module-paths
210+
--modules Architecture:arch:${ZEPHYR_BASE}/arch
211+
Driver:drivers:${ZEPHYR_BASE}/drivers
212+
Kernel:kernel:${ZEPHYR_BASE}/kernel
213+
Library:lib:${ZEPHYR_BASE}/lib
214+
Subsystem:subsys:${ZEPHYR_BASE}/subsys
215+
'External Module':modules:${ZEPHYR_BASE}/modules
216+
209217
WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
210218
COMMENT "Running genrest.py Kconfig ${RST_OUT}/doc/reference/kconfig/"
211219
)

0 commit comments

Comments
 (0)