doc: netlink: Change generated docs to limit TOC to depth 3
The tables of contents in the generated Netlink docs include individual attribute definitions. This can make the contents exceedingly long and repeats a lot of what is on the rest of the pages. See for example: https://docs.kernel.org/networking/netlink_spec/tc.html Add a depth limit to the contents directive in generated .rst files to limit the contents depth to 3 levels. This reduces the contents to: - Family - Summary - Operations - op-one - op-two - ... - Definitions - struct-one - struct-two - enum-one - ... - Attribute sets - attrs-one - attrs-two - ... Signed-off-by: Donald Hunter <donald.hunter@gmail.com> Reviewed-by: Breno Leitao <leitao@debian.org> Link: https://lore.kernel.org/r/20240329135021.52534-2-donald.hunter@gmail.com Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
committed by
Jakub Kicinski
parent
3b4cf29bda
commit
4cc1730a90
@@ -291,7 +291,7 @@ def parse_yaml(obj: Dict[str, Any]) -> str:
|
||||
|
||||
title = f"Family ``{obj['name']}`` netlink specification"
|
||||
lines.append(rst_title(title))
|
||||
lines.append(rst_paragraph(".. contents::\n"))
|
||||
lines.append(rst_paragraph(".. contents:: :depth: 3\n"))
|
||||
|
||||
if "doc" in obj:
|
||||
lines.append(rst_subtitle("Summary"))
|
||||
|
||||
Reference in New Issue
Block a user