Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Render config items "Found in:" as a set of links to menus

Browse source
This commit is contained in:
Angus Gratton 2018-09-20 17:13:07 +10:00 committed by Angus Gratton
parent 9add51bc6d
commit 9421f6611f
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
tools/kconfig_new/gen_kconfig_doc.py
View file

@ -53,7 +53,7 @@ def get_breadcrumbs(node):
node = node.parent node = node.parent
while node.parent: while node.parent:
if node.prompt: if node.prompt:
result = [ node.prompt[0] ] + result result = [ ":ref:`%s`" % get_link_anchor(node) ] + result
node = node.parent node = node.parent
return " > ".join(result) return " > ".join(result)
@ -63,12 +63,16 @@ def get_link_anchor(node):
except AttributeError: except AttributeError:
assert(node_is_menu(node)) # only menus should have no item.name assert(node_is_menu(node)) # only menus should have no item.name
result = "%s-%s" % (get_breadcrumbs(node), node.prompt[0]) # for menus, build a link anchor out of the parents
result = re.sub(r"[^a-zA-z0-9]+", "-", result).lower() result = []
while node.parent:
if node.prompt:
result = [ re.sub(r"[^a-zA-z0-9]+", "-", node.prompt[0]) ] + result
node = node.parent
result = "-".join(result).lower()
return result return result
def get_heading_level(node): def get_heading_level(node):
# bit wasteful also
result = INITIAL_HEADING_LEVEL result = INITIAL_HEADING_LEVEL
node = node.parent node = node.parent
while node.parent: while node.parent:
@ -109,7 +113,7 @@ def write_menu_item(f, node):
## Heading ## Heading
if name: if name:
title = name title = 'CONFIG_%s' % name
else: else:
# if no symbol name, use the prompt as the heading # if no symbol name, use the prompt as the heading
title = node.prompt[0] title = node.prompt[0]
@ -121,7 +125,7 @@ def write_menu_item(f, node):
if name: if name:
f.write('%s%s\n\n' % (INDENT, node.prompt[0])) f.write('%s%s\n\n' % (INDENT, node.prompt[0]))
f.write('%s:emphasis:`Found in: %s`\n\n' % (INDENT, get_breadcrumbs(node))) f.write('%s:emphasis:`Found in:` %s\n\n' % (INDENT, get_breadcrumbs(node)))
try: try:
if node.help: if node.help:
@ -154,6 +158,7 @@ def write_menu_item(f, node):
try: try:
if node_should_write(child): if node_should_write(child):
if first: if first:
f.write("Contains:\n\n")
first = False first = False
f.write('- :ref:`%s`\n' % get_link_anchor(child)) f.write('- :ref:`%s`\n' % get_link_anchor(child))
except AttributeError: except AttributeError: