doc: netlink: Change generated docs to limit TOC to depth 3
authorDonald Hunter <donald.hunter@gmail.com>
Fri, 29 Mar 2024 13:50:19 +0000 (13:50 +0000)
committerJakub Kicinski <kuba@kernel.org>
Tue, 2 Apr 2024 04:26:01 +0000 (21:26 -0700)
commit4cc1730a90fcdeac14eb44857b566a96e1170f79
tree2dea5dbc5aabfe5aedaf248deb711bb7bba83934
parent3b4cf29bdab08328dfab5bb7b41a62937ea5b379
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>
tools/net/ynl/ynl-gen-rst.py