Skip to content

Commit

Permalink
doc: netlink: Change generated docs to limit TOC to depth 3
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Donald Hunter authored and Jakub Kicinski committed Apr 2, 2024
1 parent 3b4cf29 commit 4cc1730
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion tools/net/ynl/ynl-gen-rst.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
Expand Down

0 comments on commit 4cc1730

Please sign in to comment.