| Message ID | 20240326201311.13089-2-donald.hunter@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | doc: netlink: Add hyperlinks to generated docs | expand |
On Tue, Mar 26, 2024 at 08:13:09PM +0000, Donald Hunter wrote: > 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>
diff --git a/tools/net/ynl/ynl-gen-rst.py b/tools/net/ynl/ynl-gen-rst.py index 927407b3efb3..5825a8b3bfb4 100755 --- a/tools/net/ynl/ynl-gen-rst.py +++ b/tools/net/ynl/ynl-gen-rst.py @@ -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"))
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> --- tools/net/ynl/ynl-gen-rst.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)