archives/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-03-08 02:44:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
linux/Documentation/arch/arm
History
Exact
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
..
google arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
keystone docs: keystone: fix typo in knav-qmss documentation 2026-01-06 15:03:19 -07:00
nwfpe arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
omap arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
pxa arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
sa1100 arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
samsung arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
spear arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
sti arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
stm32 docs: arm: stm32: fix typo "busses" -> "buses" 2025-08-12 12:43:59 -06:00
sunxi Documentation: Fix typos 2023-08-18 11:29:03 -06:00
vfp arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
arm.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00
booting.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
cluster-pm-race-avoidance.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
features.rst docs: kernel_feat.py: fix potential command injection 2024-01-11 09:21:01 -07:00
firmware.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
index.rst Documentation: use a source-read extension for the index link boilerplate 2026-01-23 11:59:34 -07:00
interrupts.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
ixp4xx.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00
kernel_mode_neon.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
kernel_user_helpers.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
marvell.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
mem_alignment.rst move asm/unaligned.h to linux/unaligned.h 2024-10-02 17:23:23 -04:00
memory.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
microchip.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
netwinder.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
porting.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
setup.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
sunxi.rst arm: docs: Move Arm documentation to Documentation/arch/ 2023-06-12 06:33:40 -06:00
swp_emulation.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00
tcm.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00
uefi.rst Documentation: arm: Add bootargs to the table of added DT parameters 2023-08-18 11:04:05 -06:00
vlocks.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00