Skip to content

Commit 863c170

Browse files
nashifcfriedt
authored andcommitted
doc: print tilte of Kconfig on top
Add the symbol name on top and in the page title. This will enhance search results and adds a missing page header that is needed. Signed-off-by: Anas Nashif <[email protected]>
1 parent 9960dac commit 863c170

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/_scripts/gen_kconfig_rest.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,9 +528,12 @@ def sym_header_rst(sym):
528528
#
529529
# - '.. title::' sets the title of the document (e.g. <title>). This seems
530530
# to be poorly documented at the moment.
531+
l = len(f"CONFIG_{sym.name}")
531532
return ":orphan:\n\n" \
532-
f".. title:: {sym.name}\n\n" \
533+
f".. title:: CONFIG_{sym.name}\n\n" \
533534
f".. kconfig:: CONFIG_{sym.name}\n\n" \
535+
f"CONFIG_{sym.name}\n" \
536+
f"{'#' * l}\n\n" \
534537
f"{prompt_rst(sym)}\n\n" \
535538
f"Type: ``{kconfiglib.TYPE_TO_STR[sym.type]}``\n\n"
536539

0 commit comments

Comments
 (0)