docs: netlink: link to family documentations from spec info

To increase the chances of people finding the rendered docs
add a link to specs.rst and index.rst.

Add a label in the generated index.rst and while at it adjust
the title a little bit.

Reviewed-by: Breno Leitao <leitao@debian.org>
Reviewed-by: Donald Hunter <donald.hunter@gmail.com>
Reviewed-by: Jiri Pirko <jiri@nvidia.com>
Link: https://lore.kernel.org/r/20231129041427.2763074-1-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Jakub Kicinski 2023-11-28 20:14:27 -08:00
parent 981239ee35
commit e8c780a570
3 changed files with 11 additions and 3 deletions

View File

@ -16,4 +16,6 @@ Netlink documentation for users.
genetlink-legacy genetlink-legacy
netlink-raw netlink-raw
See also :ref:`Documentation/core-api/netlink.rst <kernel_netlink>`. See also:
- :ref:`Documentation/core-api/netlink.rst <kernel_netlink>`
- :ref:`Documentation/networking/netlink_spec/index.rst <specs>`

View File

@ -15,7 +15,7 @@ kernel headers directly.
Internally kernel uses the YAML specs to generate: Internally kernel uses the YAML specs to generate:
- the C uAPI header - the C uAPI header
- documentation of the protocol as a ReST file - documentation of the protocol as a ReST file - see :ref:`Documentation/networking/netlink_spec/index.rst <specs>`
- policy tables for input attribute validation - policy tables for input attribute validation
- operation tables - operation tables

View File

@ -122,6 +122,11 @@ def rst_toctree(maxdepth: int = 2) -> str:
return "\n".join(lines) return "\n".join(lines)
def rst_label(title: str) -> str:
"""Return a formatted label"""
return f".. _{title}:\n\n"
# Parsers # Parsers
# ======= # =======
@ -349,7 +354,8 @@ def generate_main_index_rst(output: str) -> None:
lines = [] lines = []
lines.append(rst_header()) lines.append(rst_header())
lines.append(rst_title("Netlink Specification")) lines.append(rst_label("specs"))
lines.append(rst_title("Netlink Family Specifications"))
lines.append(rst_toctree(1)) lines.append(rst_toctree(1))
index_dir = os.path.dirname(output) index_dir = os.path.dirname(output)