Files
ack-tegra/Documentation/networking/index.rst
T
Jani Nikula a592a36e49 Documentation: use a source-read extension for the index link boilerplate
The root document usually has a special :ref:`genindex` link to the
generated index. This is also the case for Documentation/index.rst. The
other index.rst files deeper in the directory hierarchy usually don't.

For SPHINXDIRS builds, the root document isn't Documentation/index.rst,
but some other index.rst in the hierarchy. Currently they have a
".. only::" block to add the index link when doing SPHINXDIRS html
builds.

This is obviously very tedious and repetitive. The link is also added to
all index.rst files in the hierarchy for SPHINXDIRS builds, not just the
root document.

Put the boilerplate in a sphinx-includes/subproject-index.rst file, and
include it at the end of the root document for subproject builds in an
ad-hoc source-read extension defined in conf.py.

For now, keep having the boilerplate in translations, because this
approach currently doesn't cover translated index link headers.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Tested-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
[jc: did s/doctree/kern_doc_dir/ ]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>
2026-01-23 11:59:34 -07:00

137 lines
1.8 KiB
ReStructuredText

Networking
==========
Refer to :ref:`netdev-FAQ` for a guide on netdev development process specifics.
Contents:
.. toctree::
:maxdepth: 2
af_xdp
bareudp
batman-adv
can
can_ucan_protocol
device_drivers/index
diagnostic/index
dsa/index
devlink/index
caif/index
ethtool-netlink
ieee802154
iso15765-2
j1939
kapi
msg_zerocopy
failover
net_dim
net_failover
page_pool
phy
sfp-phylink
alias
bridge
snmp_counter
checksum-offloads
segmentation-offloads
scaling
tls
tls-offload
tls-handshake
nfc
6lowpan
6pack
arcnet-hardware
arcnet
atm
ax25
bonding
cdc_mbim
dctcp
devmem
dns_resolver
driver
eql
fib_trie
filter
generic-hdlc
generic_netlink
../netlink/specs/index
gen_stats
gtp
ila
ioam6-sysctl
iou-zcrx
ip_dynaddr
ipsec
ip-sysctl
ipv6
ipvlan
ipvs-sysctl
kcm
l2tp
lapb-module
mac80211-injection
mctp
mpls-sysctl
mptcp
mptcp-sysctl
multiqueue
multi-pf-netdev
napi
net_cachelines/index
netconsole
netdev-features
netdevices
netfilter-sysctl
netif-msg
netmem
nexthop-group-resilient
nf_conntrack-sysctl
nf_flowtable
oa-tc6-framework
openvswitch
operstates
packet_mmap
phonet
phy-link-topology
pktgen
plip
ppp_generic
proc_net_tcp
pse-pd/index
psp
radiotap-headers
rds
regulatory
representors
rxrpc
sctp
secid
seg6-sysctl
skbuff
smc-sysctl
sriov
statistics
strparser
switchdev
sysfs-tagging
tc-actions-env-rules
tc-queue-filters
tcp_ao
tcp-thin
team
timestamping
tipc
tproxy
tuntap
udplite
vrf
vxlan
x25
x25-iface
xfrm/index
xdp-rx-metadata
xsk-tx-metadata