Documentation: use a source-read extension for the index link boilerplate
Subsystems (62)
PATCH 1/1 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.
--- Documentation/RCU/index.rst | 7 ------ Documentation/accel/index.rst | 7 ------ Documentation/admin-guide/aoe/index.rst | 7 ------ .../admin-guide/auxdisplay/index.rst | 7 ------ Documentation/admin-guide/cgroup-v1/index.rst | 7 ------ Documentation/admin-guide/cifs/index.rst | 7 ------ .../admin-guide/device-mapper/index.rst | 7 ------ Documentation/admin-guide/gpio/index.rst | 7 ------ Documentation/admin-guide/index.rst | 7 ------ Documentation/admin-guide/kdump/index.rst | 7 ------ Documentation/arch/arc/index.rst | 7 ------ Documentation/arch/arm/index.rst | 8 ------- Documentation/arch/arm64/index.rst | 7 ------ Documentation/arch/loongarch/index.rst | 7 ------ Documentation/arch/m68k/index.rst | 7 ------ Documentation/arch/mips/index.rst | 7 ------ Documentation/arch/openrisc/index.rst | 7 ------ Documentation/arch/parisc/index.rst | 7 ------ Documentation/arch/powerpc/index.rst | 7 ------ Documentation/arch/riscv/index.rst | 7 ------ Documentation/arch/s390/index.rst | 7 ------ Documentation/bpf/index.rst | 7 ------ Documentation/cdrom/index.rst | 7 ------ Documentation/conf.py | 24 ++++++++++++++++++- Documentation/core-api/index.rst | 7 ------ Documentation/core-api/kho/index.rst | 2 -- Documentation/dev-tools/index.rst | 8 ------- Documentation/doc-guide/index.rst | 7 ------ Documentation/driver-api/80211/index.rst | 7 ------ Documentation/driver-api/coco/index.rst | 2 -- Documentation/driver-api/crypto/iaa/index.rst | 7 ------ Documentation/driver-api/crypto/index.rst | 7 ------ Documentation/driver-api/cxl/index.rst | 2 -- Documentation/driver-api/dmaengine/index.rst | 7 ------ .../driver-api/driver-model/index.rst | 7 ------ .../driver-api/early-userspace/index.rst | 7 ------ Documentation/driver-api/firmware/index.rst | 7 ------ Documentation/driver-api/index.rst | 7 ------ .../driver-api/memory-devices/index.rst | 7 ------ Documentation/driver-api/pci/index.rst | 7 ------ Documentation/driver-api/phy/index.rst | 8 ------- Documentation/driver-api/pm/index.rst | 7 ------ Documentation/driver-api/serial/index.rst | 7 ------ Documentation/driver-api/soundwire/index.rst | 7 ------ .../surface_aggregator/clients/index.rst | 7 ------ .../driver-api/surface_aggregator/index.rst | 7 ------ Documentation/driver-api/usb/index.rst | 7 ------ Documentation/driver-api/xilinx/index.rst | 7 ------ Documentation/fault-injection/index.rst | 7 ------ Documentation/fb/index.rst | 7 ------ Documentation/fpga/index.rst | 7 ------ Documentation/gpu/drivers.rst | 7 ------ Documentation/gpu/index.rst | 7 ------ Documentation/hwmon/index.rst | 7 ------ Documentation/i2c/index.rst | 7 ------ Documentation/infiniband/index.rst | 7 ------ Documentation/input/devices/index.rst | 7 ------ Documentation/input/index.rst | 7 ------ Documentation/isdn/index.rst | 7 ------ Documentation/kbuild/index.rst | 7 ------ Documentation/livepatch/index.rst | 7 ------ Documentation/locking/index.rst | 7 ------ Documentation/mhi/index.rst | 7 ------ Documentation/netlabel/index.rst | 7 ------ .../networking/device_drivers/atm/index.rst | 7 ------ .../networking/device_drivers/can/index.rst | 7 ------ .../device_drivers/cellular/index.rst | 7 ------ .../device_drivers/ethernet/index.rst | 7 ------ .../ethernet/mellanox/mlx5/index.rst | 7 ------ .../networking/device_drivers/fddi/index.rst | 7 ------ .../device_drivers/hamradio/index.rst | 7 ------ .../networking/device_drivers/index.rst | 7 ------ .../networking/device_drivers/wifi/index.rst | 7 ------ .../networking/device_drivers/wwan/index.rst | 7 ------ Documentation/networking/diagnostic/index.rst | 7 ------ Documentation/networking/index.rst | 7 ------ Documentation/pcmcia/index.rst | 7 ------ Documentation/peci/index.rst | 7 ------ Documentation/power/index.rst | 7 ------ Documentation/process/debugging/index.rst | 9 ------- Documentation/process/index.rst | 7 ------ Documentation/rust/index.rst | 7 ------ Documentation/scheduler/index.rst | 7 ------ Documentation/sound/index.rst | 7 ------ .../sphinx-includes/subproject-index.rst | 7 ++++++ Documentation/spi/index.rst | 7 ------ Documentation/target/index.rst | 7 ------ Documentation/tee/index.rst | 7 ------ Documentation/timers/index.rst | 7 ------ Documentation/tools/index.rst | 7 ------ Documentation/tools/rtla/index.rst | 7 ------ Documentation/tools/rv/index.rst | 7 ------ Documentation/trace/index.rst | 7 ------ Documentation/usb/index.rst | 7 ------ Documentation/userspace-api/gpio/index.rst | 7 ------ Documentation/userspace-api/index.rst | 7 ------ Documentation/virt/index.rst | 7 ------ Documentation/w1/index.rst | 7 ------ Documentation/watchdog/index.rst | 7 ------ Documentation/wmi/devices/index.rst | 7 ------ Documentation/wmi/index.rst | 8 ------- 101 files changed, 30 insertions(+), 685 deletions(-) create mode 100644 Documentation/sphinx-includes/subproject-index.rst
Documentation/RCU/index.rst +0 -7
@@ -28,10 +28,3 @@ RCU Handbook Design/Expedited-Grace-Periods/Expedited-Grace-Periods Design/Requirements/Requirements Design/Data-Structures/Data-Structures - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/accel/index.rst +0 -7
@@ -11,10 +11,3 @@ Compute Accelerators amdxdna/index qaic/index rocket/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/admin-guide/aoe/index.rst +0 -7
@@ -8,10 +8,3 @@ ATA over Ethernet (AoE) aoe todo examples - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/admin-guide/auxdisplay/index.rst +0 -7
@@ -7,10 +7,3 @@ Auxiliary Display Support ks0108.rst cfag12864b.rst - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/admin-guide/cgroup-v1/index.rst +0 -7
@@ -22,10 +22,3 @@ Control Groups version 1 net_prio pids rdma - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/admin-guide/cifs/index.rst +0 -7
@@ -12,10 +12,3 @@ CIFS todo changes authors - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/admin-guide/device-mapper/index.rst +0 -7
@@ -40,10 +40,3 @@ Device Mapper verity writecache zero - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/admin-guide/gpio/index.rst +0 -7
@@ -12,10 +12,3 @@ GPIO gpio-sim gpio-virtuser Obsolete APIs <obsolete> - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/admin-guide/index.rst +0 -7
@@ -189,10 +189,3 @@ A few hard-to-categorize and generally obsolete documents. ldm unicode - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/admin-guide/kdump/index.rst +0 -7
@@ -11,10 +11,3 @@ information. kdump vmcoreinfo - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/arc/index.rst +0 -7
@@ -8,10 +8,3 @@ ARC architecture arc features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/arm/index.rst +0 -8
@@ -75,11 +75,3 @@ SoC-specific documents sti/overview vfp/release-notes - - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/arm64/index.rst +0 -7
@@ -33,10 +33,3 @@ ARM64 Architecture tagged-pointers features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/loongarch/index.rst +0 -7
@@ -13,10 +13,3 @@ LoongArch Architecture irq-chip-model features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/m68k/index.rst +0 -7
@@ -11,10 +11,3 @@ m68k Architecture buddha-driver features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/mips/index.rst +0 -7
@@ -12,10 +12,3 @@ MIPS-specific Documentation ingenic-tcu features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/openrisc/index.rst +0 -7
@@ -11,10 +11,3 @@ OpenRISC Architecture todo features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/parisc/index.rst +0 -7
@@ -11,10 +11,3 @@ PA-RISC Architecture registers features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/powerpc/index.rst +0 -7
@@ -40,10 +40,3 @@ powerpc vpa-dtl features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/riscv/index.rst +0 -7
@@ -16,10 +16,3 @@ RISC-V architecture cmodx features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/arch/s390/index.rst +0 -7
@@ -22,10 +22,3 @@ s390 Architecture text_files features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/bpf/index.rst +0 -7
@@ -34,12 +34,5 @@ that goes into great technical depth about the BPF Architecture. other redirect -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex` - .. Links: .. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/
Documentation/cdrom/index.rst +0 -7
@@ -8,10 +8,3 @@ CD-ROM :maxdepth: 1 cdrom-standard - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/conf.py +23 -1
@@ -40,7 +40,7 @@ exclude_patterns = [] # List of patterns that contain directory names in glob format. dyn_include_patterns = [] -dyn_exclude_patterns = ["output"] +dyn_exclude_patterns = ["output", "sphinx-includes"] # Currently, only netlink/specs has a parser for yaml. # Prefer using include patterns if available, as it is faster
@@ -584,7 +584,29 @@ pdf_documents = [ kerneldoc_srctree = ".." +# Add index link at the end of the root document for SPHINXDIRS builds. +def add_subproject_index(app, docname, content): + # Only care about root documents + if docname != master_doc: + return + + # Add the index link at the root of translations, but not at the root of + # individual translations. They have their own language specific links. + rel = os.path.relpath(app.srcdir, start=doctree).split('/') + if rel[0] == 'translations' and len(rel) > 1: + return + + # Only add the link for SPHINXDIRS HTML builds + if not app.builder.tags.has('subproject') or not app.builder.tags.has('html'): + return + + # The include directive needs a relative path from the srcdir + rel = os.path.relpath(os.path.join(doctree, 'sphinx-includes/subproject-index.rst'), start=app.srcdir) + + content[0] += f'\n.. include:: {rel}\n\n' + def setup(app): """Patterns need to be updated at init time on older Sphinx versions""" app.connect('config-inited', config_init) + app.connect('source-read', add_subproject_index)
Documentation/core-api/index.rst +0 -7
@@ -140,10 +140,3 @@ Documents that don't fit elsewhere or which have yet to be categorized. librs liveupdate netlink - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/core-api/kho/index.rst +0 -2
@@ -9,5 +9,3 @@ Kexec Handover Subsystem concepts fdt - -.. only:: subproject and html
Documentation/dev-tools/index.rst +0 -8
@@ -38,11 +38,3 @@ Documentation/process/debugging/index.rst gpio-sloppy-logic-analyzer autofdo propeller - - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/doc-guide/index.rst +0 -7
@@ -13,10 +13,3 @@ How to write kernel documentation contributing maintainer-profile checktransupdate - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/80211/index.rst +0 -7
@@ -8,10 +8,3 @@ Linux 802.11 Driver Developer's Guide cfg80211 mac80211 mac80211-advanced - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/coco/index.rst +0 -2
@@ -8,5 +8,3 @@ Confidential Computing :maxdepth: 1 measurement-registers - -.. only:: subproject and html
Documentation/driver-api/crypto/iaa/index.rst +0 -7
@@ -11,10 +11,3 @@ API. :maxdepth: 1 iaa-crypto - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/crypto/index.rst +0 -7
@@ -11,10 +11,3 @@ configuration. :maxdepth: 1 iaa/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/cxl/index.rst +0 -2
@@ -50,5 +50,3 @@ that have impacts on each other. The docs here break up configurations steps. allocation/page-allocator allocation/reclaim allocation/hugepages.rst - -.. only:: subproject and html
Documentation/driver-api/dmaengine/index.rst +0 -7
@@ -46,10 +46,3 @@ This book adds some notes about PXA DMA :maxdepth: 1 pxa_dma - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/driver-model/index.rst +0 -7
@@ -14,10 +14,3 @@ Driver Model overview platform porting - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/early-userspace/index.rst +0 -7
@@ -9,10 +9,3 @@ Early Userspace early_userspace_support buffer-format - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/firmware/index.rst +0 -7
@@ -10,10 +10,3 @@ Linux Firmware API request_firmware fw_upload other_interfaces - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/index.rst +0 -7
@@ -149,10 +149,3 @@ Subsystem-specific APIs wmi xilinx/index zorro - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/memory-devices/index.rst +0 -7
@@ -9,10 +9,3 @@ Memory Controller drivers ti-emif ti-gpmc - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/pci/index.rst +0 -7
@@ -11,10 +11,3 @@ The Linux PCI driver implementer's API guide pci p2pdma tsm - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/phy/index.rst +0 -8
@@ -8,11 +8,3 @@ Generic PHY Framework phy samsung-usb2 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex` -
Documentation/driver-api/pm/index.rst +0 -7
@@ -10,10 +10,3 @@ CPU and Device Power Management devices notifiers types - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/serial/index.rst +0 -7
@@ -18,10 +18,3 @@ Serial drivers serial-iso7816 serial-rs485 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/soundwire/index.rst +0 -7
@@ -11,10 +11,3 @@ SoundWire Documentation locking bra bra_cadence - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/surface_aggregator/clients/index.rst +0 -7
@@ -14,10 +14,3 @@ on how to write client drivers. cdev dtx san - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/surface_aggregator/index.rst +0 -7
@@ -12,10 +12,3 @@ Surface System Aggregator Module (SSAM) clients/index ssh internal - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/usb/index.rst +0 -7
@@ -22,10 +22,3 @@ Linux USB API typec typec_bus usb3-debug-port - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/driver-api/xilinx/index.rst +0 -7
@@ -7,10 +7,3 @@ Xilinx FPGA :maxdepth: 1 eemi - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/fault-injection/index.rst +0 -7
@@ -11,10 +11,3 @@ Fault-injection notifier-error-inject nvme-fault-injection provoke-crashes - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/fb/index.rst +0 -7
@@ -50,10 +50,3 @@ Driver documentation vesafb viafb vt8623fb - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/fpga/index.rst +0 -7
@@ -8,10 +8,3 @@ FPGA :maxdepth: 1 dfl - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/gpu/drivers.rst +0 -7
@@ -26,10 +26,3 @@ GPU Driver Documentation panthor zynqmp nova/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/gpu/index.rst +0 -7
@@ -22,10 +22,3 @@ GPU Driver Developer's Guide implementation_guidelines todo rfc/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/hwmon/index.rst +0 -7
@@ -281,10 +281,3 @@ Hardware Monitoring Kernel Drivers xdpe12284 xdpe152c4 zl6100 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/i2c/index.rst +0 -7
@@ -66,10 +66,3 @@ Legacy documentation :maxdepth: 1 old-module-parameters - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/infiniband/index.rst +0 -7
@@ -15,10 +15,3 @@ InfiniBand ucaps user_mad user_verbs - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/input/devices/index.rst +0 -7
@@ -10,10 +10,3 @@ Linux kernel, their protocols, and driver details. :glob: * - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/input/index.rst +0 -7
@@ -10,10 +10,3 @@ Contents: input_uapi input_kapi devices/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/isdn/index.rst +0 -7
@@ -12,10 +12,3 @@ ISDN m_isdn credits - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/kbuild/index.rst +0 -7
@@ -24,10 +24,3 @@ Kernel Build System gendwarfksyms bash-completion - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/livepatch/index.rst +0 -7
@@ -15,10 +15,3 @@ Kernel Livepatching system-state reliable-stacktrace api - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/locking/index.rst +0 -7
@@ -24,10 +24,3 @@ Locking percpu-rw-semaphore robust-futexes robust-futex-ABI - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/mhi/index.rst +0 -7
@@ -9,10 +9,3 @@ MHI mhi topology - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/netlabel/index.rst +0 -7
@@ -12,10 +12,3 @@ NetLabel lsm_interface draft_ietf - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/atm/index.rst +0 -7
@@ -11,10 +11,3 @@ Contents: cxacru fore200e iphase - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/can/index.rst +0 -7
@@ -13,10 +13,3 @@ Contents: can327 ctu/ctucanfd-driver freescale/flexcan - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/cellular/index.rst +0 -7
@@ -9,10 +9,3 @@ Contents: :maxdepth: 2 qualcomm/rmnet - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/ethernet/index.rst +0 -7
@@ -64,10 +64,3 @@ Contents: wangxun/txgbevf wangxun/ngbe wangxun/ngbevf - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/ethernet/mellanox/mlx5/index.rst +0 -7
@@ -16,10 +16,3 @@ Contents: switchdev tracepoints counters - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/fddi/index.rst +0 -7
@@ -10,10 +10,3 @@ Contents: defza skfp - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/hamradio/index.rst +0 -7
@@ -10,10 +10,3 @@ Contents: baycom z8530drv - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/index.rst +0 -7
@@ -16,10 +16,3 @@ Contents: hamradio/index wifi/index wwan/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/wifi/index.rst +0 -7
@@ -10,10 +10,3 @@ Contents: intel/ipw2100 intel/ipw2200 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/device_drivers/wwan/index.rst +0 -7
@@ -10,10 +10,3 @@ Contents: iosm t7xx - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/diagnostic/index.rst +0 -7
@@ -8,10 +8,3 @@ Networking Diagnostics :maxdepth: 2 twisted_pair_layer1_diagnostics.rst - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/networking/index.rst +0 -7
@@ -134,10 +134,3 @@ Contents: xfrm/index xdp-rx-metadata xsk-tx-metadata - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/pcmcia/index.rst +0 -7
@@ -11,10 +11,3 @@ PCMCIA devicetable locking driver-changes - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/peci/index.rst +0 -7
@@ -7,10 +7,3 @@ PECI Subsystem .. toctree:: peci - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/power/index.rst +0 -7
@@ -38,10 +38,3 @@ Power Management regulator/machine regulator/overview regulator/regulator - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/process/debugging/index.rst +0 -9
@@ -15,8 +15,6 @@ general guides kgdb userspace_debugging_guide -.. only:: subproject and html - subsystem specific guides -------------------------
@@ -25,13 +23,6 @@ subsystem specific guides media_specific_debugging_guide -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex` - General debugging advice ========================
Documentation/process/index.rst +0 -7
@@ -110,10 +110,3 @@ developers: kernel-docs deprecated - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/rust/index.rst +0 -7
@@ -58,10 +58,3 @@ more details. You can also find learning materials for Rust in its section in :doc:`../process/kernel-docs`. - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/scheduler/index.rst +0 -7
@@ -25,10 +25,3 @@ Scheduler sched-debug text_files - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/sound/index.rst +0 -7
@@ -15,10 +15,3 @@ Sound Subsystem Documentation cards/index codecs/index utimers - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/sphinx-includes/subproject-index.rst new file +7 -0
@@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: GPL-2.0 +.. This file is included in subproject root documents in conf.py + +Indices +======= + +* :ref:`genindex`
Documentation/spi/index.rst +0 -7
@@ -12,10 +12,3 @@ Serial Peripheral Interface (SPI) butterfly spi-lm70llp spi-sc18is602 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/target/index.rst +0 -7
@@ -10,10 +10,3 @@ TCM Virtual Device tcmu-design tcm_mod_builder scripts - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/tee/index.rst +0 -7
@@ -12,10 +12,3 @@ TEE Subsystem amd-tee ts-tee qtee - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/timers/index.rst +0 -7
@@ -13,10 +13,3 @@ Timers no_hz timekeeping delay_sleep_functions - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/tools/index.rst +0 -7
@@ -12,10 +12,3 @@ more additions are needed here: rtla/index rv/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/tools/rtla/index.rst +0 -7
@@ -18,10 +18,3 @@ behavior on specific hardware. rtla-timerlat-hist rtla-timerlat-top rtla-hwnoise - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/tools/rv/index.rst +0 -7
@@ -16,10 +16,3 @@ Runtime verification (rv) tool rv-mon-wip rv-mon-wwnr rv-mon-sched - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/trace/index.rst +0 -7
@@ -95,10 +95,3 @@ Additional Resources For more details, refer to the respective documentation of each tracing tool and framework. - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/usb/index.rst +0 -7
@@ -31,10 +31,3 @@ USB support usb-help text_files - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/userspace-api/gpio/index.rst +0 -7
@@ -9,10 +9,3 @@ GPIO Character Device Userspace API <chardev> Obsolete Userspace APIs <obsolete> - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/userspace-api/index.rst +0 -7
@@ -68,10 +68,3 @@ Everything else futex2 perf_ring_buffer ntsync - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/virt/index.rst +0 -7
@@ -16,10 +16,3 @@ Virtualization Support coco/sev-guest coco/tdx-guest hyperv/index - -.. only:: html and subproject - - Indices - ======= - - * :ref:`genindex`
Documentation/w1/index.rst +0 -7
@@ -12,10 +12,3 @@ w1-netlink.rst masters/index slaves/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/watchdog/index.rst +0 -7
@@ -16,10 +16,3 @@ Watchdog Support watchdog-pm wdt convert_drivers_to_kernel_api - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/wmi/devices/index.rst +0 -7
@@ -13,10 +13,3 @@ the Linux kernel, their protocols and driver details. :glob: * - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`
Documentation/wmi/index.rst +0 -8
@@ -10,11 +10,3 @@ WMI Subsystem acpi-interface driver-development-guide devices/index - -.. only:: subproject and html - - - Indices - ======= - - * :ref:`genindex`
Signature · 1 line
2.47.3
Quoted 13 lines · On Fri, 23 Jan 2026 16:31:49 +0200 Jani Nikula <[email protected]> wrote:
The root document usually has a special :ref:
genindexlink to the generated index. This is also the case forDocumentation/index.rst. The otherindex.rstfiles deeper in the directory hierarchy usually don't.For SPHINXDIRS builds, the root document isn't
Documentation/index.rst, but some otherindex.rstin 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.rstfiles in the hierarchy for SPHINXDIRS builds, not just the root document.
Quoted 6 lines
Put the boilerplate in a
sphinx-includes/subproject-index.rstfile, and include it at the end of the root document for subproject builds in an ad-hoc source-read extension defined inconf.py.For now, keep having the boilerplate in translations, because this approach currently doesn't cover translated index link headers.
Nice cleanup.
I was able to build both "peci" and "userspace-api/media" using it. On both, the "indexes" were properly added.
So:
Quoted 1,654 lines
Cc Jonathan Corbet <[email protected]>Cc Mauro Carvalho Chehab <[email protected]>Cc Randy Dunlap <[email protected]>Signed-off-by Jani Nikula <[email protected]>--- Documentation/RCU/index.rst | 7 ------ Documentation/accel/index.rst | 7 ------ Documentation/admin-guide/aoe/index.rst | 7 ------ .../admin-guide/auxdisplay/index.rst | 7 ------ Documentation/admin-guide/cgroup-v1/index.rst | 7 ------ Documentation/admin-guide/cifs/index.rst | 7 ------ .../admin-guide/device-mapper/index.rst | 7 ------ Documentation/admin-guide/gpio/index.rst | 7 ------ Documentation/admin-guide/index.rst | 7 ------ Documentation/admin-guide/kdump/index.rst | 7 ------ Documentation/arch/arc/index.rst | 7 ------ Documentation/arch/arm/index.rst | 8 ------- Documentation/arch/arm64/index.rst | 7 ------ Documentation/arch/loongarch/index.rst | 7 ------ Documentation/arch/m68k/index.rst | 7 ------ Documentation/arch/mips/index.rst | 7 ------ Documentation/arch/openrisc/index.rst | 7 ------ Documentation/arch/parisc/index.rst | 7 ------ Documentation/arch/powerpc/index.rst | 7 ------ Documentation/arch/riscv/index.rst | 7 ------ Documentation/arch/s390/index.rst | 7 ------ Documentation/bpf/index.rst | 7 ------ Documentation/cdrom/index.rst | 7 ------ Documentation/conf.py | 24 ++++++++++++++++++- Documentation/core-api/index.rst | 7 ------ Documentation/core-api/kho/index.rst | 2 -- Documentation/dev-tools/index.rst | 8 ------- Documentation/doc-guide/index.rst | 7 ------ Documentation/driver-api/80211/index.rst | 7 ------ Documentation/driver-api/coco/index.rst | 2 -- Documentation/driver-api/crypto/iaa/index.rst | 7 ------ Documentation/driver-api/crypto/index.rst | 7 ------ Documentation/driver-api/cxl/index.rst | 2 -- Documentation/driver-api/dmaengine/index.rst | 7 ------ .../driver-api/driver-model/index.rst | 7 ------ .../driver-api/early-userspace/index.rst | 7 ------ Documentation/driver-api/firmware/index.rst | 7 ------ Documentation/driver-api/index.rst | 7 ------ .../driver-api/memory-devices/index.rst | 7 ------ Documentation/driver-api/pci/index.rst | 7 ------ Documentation/driver-api/phy/index.rst | 8 ------- Documentation/driver-api/pm/index.rst | 7 ------ Documentation/driver-api/serial/index.rst | 7 ------ Documentation/driver-api/soundwire/index.rst | 7 ------ .../surface_aggregator/clients/index.rst | 7 ------ .../driver-api/surface_aggregator/index.rst | 7 ------ Documentation/driver-api/usb/index.rst | 7 ------ Documentation/driver-api/xilinx/index.rst | 7 ------ Documentation/fault-injection/index.rst | 7 ------ Documentation/fb/index.rst | 7 ------ Documentation/fpga/index.rst | 7 ------ Documentation/gpu/drivers.rst | 7 ------ Documentation/gpu/index.rst | 7 ------ Documentation/hwmon/index.rst | 7 ------ Documentation/i2c/index.rst | 7 ------ Documentation/infiniband/index.rst | 7 ------ Documentation/input/devices/index.rst | 7 ------ Documentation/input/index.rst | 7 ------ Documentation/isdn/index.rst | 7 ------ Documentation/kbuild/index.rst | 7 ------ Documentation/livepatch/index.rst | 7 ------ Documentation/locking/index.rst | 7 ------ Documentation/mhi/index.rst | 7 ------ Documentation/netlabel/index.rst | 7 ------ .../networking/device_drivers/atm/index.rst | 7 ------ .../networking/device_drivers/can/index.rst | 7 ------ .../device_drivers/cellular/index.rst | 7 ------ .../device_drivers/ethernet/index.rst | 7 ------ .../ethernet/mellanox/mlx5/index.rst | 7 ------ .../networking/device_drivers/fddi/index.rst | 7 ------ .../device_drivers/hamradio/index.rst | 7 ------ .../networking/device_drivers/index.rst | 7 ------ .../networking/device_drivers/wifi/index.rst | 7 ------ .../networking/device_drivers/wwan/index.rst | 7 ------ Documentation/networking/diagnostic/index.rst | 7 ------ Documentation/networking/index.rst | 7 ------ Documentation/pcmcia/index.rst | 7 ------ Documentation/peci/index.rst | 7 ------ Documentation/power/index.rst | 7 ------ Documentation/process/debugging/index.rst | 9 ------- Documentation/process/index.rst | 7 ------ Documentation/rust/index.rst | 7 ------ Documentation/scheduler/index.rst | 7 ------ Documentation/sound/index.rst | 7 ------ .../sphinx-includes/subproject-index.rst | 7 ++++++ Documentation/spi/index.rst | 7 ------ Documentation/target/index.rst | 7 ------ Documentation/tee/index.rst | 7 ------ Documentation/timers/index.rst | 7 ------ Documentation/tools/index.rst | 7 ------ Documentation/tools/rtla/index.rst | 7 ------ Documentation/tools/rv/index.rst | 7 ------ Documentation/trace/index.rst | 7 ------ Documentation/usb/index.rst | 7 ------ Documentation/userspace-api/gpio/index.rst | 7 ------ Documentation/userspace-api/index.rst | 7 ------ Documentation/virt/index.rst | 7 ------ Documentation/w1/index.rst | 7 ------ Documentation/watchdog/index.rst | 7 ------ Documentation/wmi/devices/index.rst | 7 ------ Documentation/wmi/index.rst | 8 ------- 101 files changed, 30 insertions(+), 685 deletions(-) create mode 100644 Documentation/sphinx-includes/subproject-index.rstDocumentation/RCU/index.rst +0
-7@@ -28,10 +28,3 @@ RCU Handbook Design/Expedited-Grace-Periods/Expedited-Grace-Periods Design/Requirements/Requirements Design/Data-Structures/Data-Structures - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/accel/index.rst +0
-7@@ -11,10 +11,3 @@ Compute Accelerators amdxdna/index qaic/index rocket/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/admin-guide/aoe/index.rst +0
-7@@ -8,10 +8,3 @@ ATA over Ethernet (AoE) aoe todo examples - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/admin-guide/auxdisplay/index.rst +0
-7@@ -7,10 +7,3 @@ Auxiliary Display Support ks0108.rst cfag12864b.rst - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/admin-guide/cgroup-v1/index.rst +0
-7@@ -22,10 +22,3 @@ Control Groups version 1 net_prio pids rdma - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/admin-guide/cifs/index.rst +0
-7@@ -12,10 +12,3 @@ CIFS todo changes authors - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/admin-guide/device-mapper/index.rst +0
-7@@ -40,10 +40,3 @@ Device Mapper verity writecache zero - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/admin-guide/gpio/index.rst +0
-7@@ -12,10 +12,3 @@ GPIO gpio-sim gpio-virtuser Obsolete APIs <obsolete> - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/admin-guide/index.rst +0
-7@@ -189,10 +189,3 @@ A few hard-to-categorize and generally obsolete documents. ldm unicode - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/admin-guide/kdump/index.rst +0
-7@@ -11,10 +11,3 @@ information. kdump vmcoreinfo - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/arc/index.rst +0
-7@@ -8,10 +8,3 @@ ARC architecture arc features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/arm/index.rst +0
-8@@ -75,11 +75,3 @@ SoC-specific documents sti/overview vfp/release-notes - - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/arm64/index.rst +0
-7@@ -33,10 +33,3 @@ ARM64 Architecture tagged-pointers features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/loongarch/index.rst +0
-7@@ -13,10 +13,3 @@ LoongArch Architecture irq-chip-model features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/m68k/index.rst +0
-7@@ -11,10 +11,3 @@ m68k Architecture buddha-driver features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/mips/index.rst +0
-7@@ -12,10 +12,3 @@ MIPS-specific Documentation ingenic-tcu features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/openrisc/index.rst +0
-7@@ -11,10 +11,3 @@ OpenRISC Architecture todo features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/parisc/index.rst +0
-7@@ -11,10 +11,3 @@ PA-RISC Architecture registers features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/powerpc/index.rst +0
-7@@ -40,10 +40,3 @@ powerpc vpa-dtl features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/riscv/index.rst +0
-7@@ -16,10 +16,3 @@ RISC-V architecture cmodx features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/arch/s390/index.rst +0
-7@@ -22,10 +22,3 @@ s390 Architecture text_files features - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/bpf/index.rst +0
-7@@ -34,12 +34,5 @@ that goes into great technical depth about the BPF Architecture. other redirect -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex` - .. Links: .. _BPF and XDP Reference Guide: https://docs.cilium.io/en/latest/bpf/Documentation/cdrom/index.rst +0
-7@@ -8,10 +8,3 @@ CD-ROM :maxdepth: 1 cdrom-standard - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/conf.py +23
-1@@ -40,7 +40,7 @@ exclude_patterns = [] # List of patterns that contain directory names in glob format. dyn_include_patterns = [] -dyn_exclude_patterns = ["output"] +dyn_exclude_patterns = ["output", "sphinx-includes"] # Currently, only netlink/specs has a parser for yaml. # Prefer using include patterns if available, as it is faster@@ -584,7 +584,29 @@ pdf_documents = [ kerneldoc_srctree = ".." +# Add index link at the end of the root document for SPHINXDIRS builds. +def add_subproject_index(app, docname, content): + # Only care about root documents + if docname != master_doc: + return + + # Add the index link at the root of translations, but not at the root of + # individual translations. They have their own language specific links. + rel = os.path.relpath(app.srcdir, start=doctree).split('/') + if rel[0] == 'translations' and len(rel) > 1: + return + + # Only add the link for SPHINXDIRS HTML builds + if not app.builder.tags.has('subproject') or not app.builder.tags.has('html'): + return + + # The include directive needs a relative path from the srcdir + rel = os.path.relpath(os.path.join(doctree, 'sphinx-includes/subproject-index.rst'), start=app.srcdir) + + content[0] += f'\n.. include:: {rel}\n\n' + def setup(app): """Patterns need to be updated at init time on older Sphinx versions""" app.connect('config-inited', config_init) + app.connect('source-read', add_subproject_index)Documentation/core-api/index.rst +0
-7@@ -140,10 +140,3 @@ Documents that don't fit elsewhere or which have yet to be categorized. librs liveupdate netlink - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/core-api/kho/index.rst +0
-2@@ -9,5 +9,3 @@ Kexec Handover Subsystem concepts fdt - -.. only:: subproject and htmlDocumentation/dev-tools/index.rst +0
-8@@ -38,11 +38,3 @@ Documentation/process/debugging/index.rst gpio-sloppy-logic-analyzer autofdo propeller - - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/doc-guide/index.rst +0
-7@@ -13,10 +13,3 @@ How to write kernel documentation contributing maintainer-profile checktransupdate - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/80211/index.rst +0
-7@@ -8,10 +8,3 @@ Linux 802.11 Driver Developer's Guide cfg80211 mac80211 mac80211-advanced - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/coco/index.rst +0
-2@@ -8,5 +8,3 @@ Confidential Computing :maxdepth: 1 measurement-registers - -.. only:: subproject and htmlDocumentation/driver-api/crypto/iaa/index.rst +0
-7@@ -11,10 +11,3 @@ API. :maxdepth: 1 iaa-crypto - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/crypto/index.rst +0
-7@@ -11,10 +11,3 @@ configuration. :maxdepth: 1 iaa/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/cxl/index.rst +0
-2@@ -50,5 +50,3 @@ that have impacts on each other. The docs here break up configurations steps. allocation/page-allocator allocation/reclaim allocation/hugepages.rst - -.. only:: subproject and htmlDocumentation/driver-api/dmaengine/index.rst +0
-7@@ -46,10 +46,3 @@ This book adds some notes about PXA DMA :maxdepth: 1 pxa_dma - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/driver-model/index.rst +0
-7@@ -14,10 +14,3 @@ Driver Model overview platform porting - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/early-userspace/index.rst +0
-7@@ -9,10 +9,3 @@ Early Userspace early_userspace_support buffer-format - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/firmware/index.rst +0
-7@@ -10,10 +10,3 @@ Linux Firmware API request_firmware fw_upload other_interfaces - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/index.rst +0
-7@@ -149,10 +149,3 @@ Subsystem-specific APIs wmi xilinx/index zorro - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/memory-devices/index.rst +0
-7@@ -9,10 +9,3 @@ Memory Controller drivers ti-emif ti-gpmc - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/pci/index.rst +0
-7@@ -11,10 +11,3 @@ The Linux PCI driver implementer's API guide pci p2pdma tsm - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/phy/index.rst +0
-8@@ -8,11 +8,3 @@ Generic PHY Framework phy samsung-usb2 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex` -Documentation/driver-api/pm/index.rst +0
-7@@ -10,10 +10,3 @@ CPU and Device Power Management devices notifiers types - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/serial/index.rst +0
-7@@ -18,10 +18,3 @@ Serial drivers serial-iso7816 serial-rs485 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/soundwire/index.rst +0
-7@@ -11,10 +11,3 @@ SoundWire Documentation locking bra bra_cadence - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/surface_aggregator/clients/index.rst +0
-7@@ -14,10 +14,3 @@ on how to write client drivers. cdev dtx san - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/surface_aggregator/index.rst +0
-7@@ -12,10 +12,3 @@ Surface System Aggregator Module (SSAM) clients/index ssh internal - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/usb/index.rst +0
-7@@ -22,10 +22,3 @@ Linux USB API typec typec_bus usb3-debug-port - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/driver-api/xilinx/index.rst +0
-7@@ -7,10 +7,3 @@ Xilinx FPGA :maxdepth: 1 eemi - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/fault-injection/index.rst +0
-7@@ -11,10 +11,3 @@ Fault-injection notifier-error-inject nvme-fault-injection provoke-crashes - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/fb/index.rst +0
-7@@ -50,10 +50,3 @@ Driver documentation vesafb viafb vt8623fb - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/fpga/index.rst +0
-7@@ -8,10 +8,3 @@ FPGA :maxdepth: 1 dfl - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/gpu/drivers.rst +0
-7@@ -26,10 +26,3 @@ GPU Driver Documentation panthor zynqmp nova/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/gpu/index.rst +0
-7@@ -22,10 +22,3 @@ GPU Driver Developer's Guide implementation_guidelines todo rfc/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/hwmon/index.rst +0
-7@@ -281,10 +281,3 @@ Hardware Monitoring Kernel Drivers xdpe12284 xdpe152c4 zl6100 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/i2c/index.rst +0
-7@@ -66,10 +66,3 @@ Legacy documentation :maxdepth: 1 old-module-parameters - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/infiniband/index.rst +0
-7@@ -15,10 +15,3 @@ InfiniBand ucaps user_mad user_verbs - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/input/devices/index.rst +0
-7@@ -10,10 +10,3 @@ Linux kernel, their protocols, and driver details. :glob: * - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/input/index.rst +0
-7@@ -10,10 +10,3 @@ Contents: input_uapi input_kapi devices/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/isdn/index.rst +0
-7@@ -12,10 +12,3 @@ ISDN m_isdn credits - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/kbuild/index.rst +0
-7@@ -24,10 +24,3 @@ Kernel Build System gendwarfksyms bash-completion - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/livepatch/index.rst +0
-7@@ -15,10 +15,3 @@ Kernel Livepatching system-state reliable-stacktrace api - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/locking/index.rst +0
-7@@ -24,10 +24,3 @@ Locking percpu-rw-semaphore robust-futexes robust-futex-ABI - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/mhi/index.rst +0
-7@@ -9,10 +9,3 @@ MHI mhi topology - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/netlabel/index.rst +0
-7@@ -12,10 +12,3 @@ NetLabel lsm_interface draft_ietf - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/atm/index.rst +0
-7@@ -11,10 +11,3 @@ Contents: cxacru fore200e iphase - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/can/index.rst +0
-7@@ -13,10 +13,3 @@ Contents: can327 ctu/ctucanfd-driver freescale/flexcan - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/cellular/index.rst +0
-7@@ -9,10 +9,3 @@ Contents: :maxdepth: 2 qualcomm/rmnet - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/ethernet/index.rst +0
-7@@ -64,10 +64,3 @@ Contents: wangxun/txgbevf wangxun/ngbe wangxun/ngbevf - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/ethernet/mellanox/mlx5/index.rst +0
-7@@ -16,10 +16,3 @@ Contents: switchdev tracepoints counters - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/fddi/index.rst +0
-7@@ -10,10 +10,3 @@ Contents: defza skfp - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/hamradio/index.rst +0
-7@@ -10,10 +10,3 @@ Contents: baycom z8530drv - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/index.rst +0
-7@@ -16,10 +16,3 @@ Contents: hamradio/index wifi/index wwan/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/wifi/index.rst +0
-7@@ -10,10 +10,3 @@ Contents: intel/ipw2100 intel/ipw2200 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/device_drivers/wwan/index.rst +0
-7@@ -10,10 +10,3 @@ Contents: iosm t7xx - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/diagnostic/index.rst +0
-7@@ -8,10 +8,3 @@ Networking Diagnostics :maxdepth: 2 twisted_pair_layer1_diagnostics.rst - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/networking/index.rst +0
-7@@ -134,10 +134,3 @@ Contents: xfrm/index xdp-rx-metadata xsk-tx-metadata - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/pcmcia/index.rst +0
-7@@ -11,10 +11,3 @@ PCMCIA devicetable locking driver-changes - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/peci/index.rst +0
-7@@ -7,10 +7,3 @@ PECI Subsystem .. toctree:: peci - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/power/index.rst +0
-7@@ -38,10 +38,3 @@ Power Management regulator/machine regulator/overview regulator/regulator - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/process/debugging/index.rst +0
-9@@ -15,8 +15,6 @@ general guides kgdb userspace_debugging_guide -.. only:: subproject and html - subsystem specific guides -------------------------@@ -25,13 +23,6 @@ subsystem specific guides media_specific_debugging_guide -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex` - General debugging advice ========================Documentation/process/index.rst +0
-7@@ -110,10 +110,3 @@ developers: kernel-docs deprecated - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/rust/index.rst +0
-7@@ -58,10 +58,3 @@ more details. You can also find learning materials for Rust in its section in :doc:`../process/kernel-docs`. - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/scheduler/index.rst +0
-7@@ -25,10 +25,3 @@ Scheduler sched-debug text_files - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/sound/index.rst +0
-7@@ -15,10 +15,3 @@ Sound Subsystem Documentation cards/index codecs/index utimers - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/sphinx-includes/subproject-index.rst new file +7
-0@@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: GPL-2.0 +.. This file is included in subproject root documents in conf.py + +Indices +======= + +* :ref:`genindex`Documentation/spi/index.rst +0
-7@@ -12,10 +12,3 @@ Serial Peripheral Interface (SPI) butterfly spi-lm70llp spi-sc18is602 - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/target/index.rst +0
-7@@ -10,10 +10,3 @@ TCM Virtual Device tcmu-design tcm_mod_builder scripts - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/tee/index.rst +0
-7@@ -12,10 +12,3 @@ TEE Subsystem amd-tee ts-tee qtee - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/timers/index.rst +0
-7@@ -13,10 +13,3 @@ Timers no_hz timekeeping delay_sleep_functions - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/tools/index.rst +0
-7@@ -12,10 +12,3 @@ more additions are needed here: rtla/index rv/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/tools/rtla/index.rst +0
-7@@ -18,10 +18,3 @@ behavior on specific hardware. rtla-timerlat-hist rtla-timerlat-top rtla-hwnoise - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/tools/rv/index.rst +0
-7@@ -16,10 +16,3 @@ Runtime verification (rv) tool rv-mon-wip rv-mon-wwnr rv-mon-sched - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/trace/index.rst +0
-7@@ -95,10 +95,3 @@ Additional Resources For more details, refer to the respective documentation of each tracing tool and framework. - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/usb/index.rst +0
-7@@ -31,10 +31,3 @@ USB support usb-help text_files - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/userspace-api/gpio/index.rst +0
-7@@ -9,10 +9,3 @@ GPIO Character Device Userspace API <chardev> Obsolete Userspace APIs <obsolete> - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/userspace-api/index.rst +0
-7@@ -68,10 +68,3 @@ Everything else futex2 perf_ring_buffer ntsync - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/virt/index.rst +0
-7@@ -16,10 +16,3 @@ Virtualization Support coco/sev-guest coco/tdx-guest hyperv/index - -.. only:: html and subproject - - Indices - ======= - - * :ref:`genindex`Documentation/w1/index.rst +0
-7@@ -12,10 +12,3 @@ w1-netlink.rst masters/index slaves/index - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/watchdog/index.rst +0
-7@@ -16,10 +16,3 @@ Watchdog Support watchdog-pm wdt convert_drivers_to_kernel_api - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/wmi/devices/index.rst +0
-7@@ -13,10 +13,3 @@ the Linux kernel, their protocols and driver details. :glob: * - -.. only:: subproject and html - - Indices - ======= - - * :ref:`genindex`Documentation/wmi/index.rst +0
-8@@ -10,11 +10,3 @@ WMI Subsystem acpi-interface driver-development-guide devices/index - -.. only:: subproject and html - - - Indices - ======= - - * :ref:`genindex`
Jonathan Corbet
maintainerQuoted 19 lines · Jani Nikula
The root document usually has a special :ref:
genindexlink to the generated index. This is also the case forDocumentation/index.rst. The otherindex.rstfiles deeper in the directory hierarchy usually don't.For SPHINXDIRS builds, the root document isn't
Documentation/index.rst, but some otherindex.rstin 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.rstfiles in the hierarchy for SPHINXDIRS builds, not just the root document.Put the boilerplate in a
sphinx-includes/subproject-index.rstfile, and include it at the end of the root document for subproject builds in an ad-hoc source-read extension defined inconf.py.For now, keep having the boilerplate in translations, because this approach currently doesn't cover translated index link headers.
[...]
Quoted 1 line
101 files changed, 30 insertions(+), 685 deletions(-)
Whee ... I do like that!
This patch, when applied after Mauro's massive python-doc series, causes the build to crash, since he renamed "doctree". So I've taken the liberty of applying it with this tweak.
Thanks,
jon
Documentation/conf.py +2 -2
@@ -595,7 +595,7 @@ def add_subproject_index(app, docname, content): # Add the index link at the root of translations, but not at the root of # individual translations. They have their own language specific links. - rel = os.path.relpath(app.srcdir, start=doctree).split('/') + rel = os.path.relpath(app.srcdir, start=kern_doc_dir).split('/') if rel[0] == 'translations' and len(rel) > 1: return
@@ -604,7 +604,7 @@ def add_subproject_index(app, docname, content): return # The include directive needs a relative path from the srcdir - rel = os.path.relpath(os.path.join(doctree, 'sphinx-includes/subproject-index.rst'), start=app.srcdir) + rel = os.path.relpath(os.path.join(kern_doc_dir, 'sphinx-includes/subproject-index.rst'), start=app.srcdir) content[0] += f'\n.. include:: {rel}\n\n'