Jani Nikula
a592a36e49
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>
53 lines
1.0 KiB
ReStructuredText
53 lines
1.0 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
====================
|
|
Compute Express Link
|
|
====================
|
|
|
|
CXL device configuration has a complex handoff between platform (Hardware,
|
|
BIOS, EFI), OS (early boot, core kernel, driver), and user policy decisions
|
|
that have impacts on each other. The docs here break up configurations steps.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Overview
|
|
|
|
theory-of-operation
|
|
maturity-map
|
|
conventions
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Device Reference
|
|
|
|
devices/device-types
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Platform Configuration
|
|
|
|
platform/bios-and-efi
|
|
platform/acpi
|
|
platform/cdat
|
|
platform/example-configs
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Linux Kernel Configuration
|
|
|
|
linux/overview
|
|
linux/early-boot
|
|
linux/cxl-driver
|
|
linux/dax-driver
|
|
linux/memory-hotplug
|
|
linux/access-coordinates
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Memory Allocation
|
|
|
|
allocation/dax
|
|
allocation/page-allocator
|
|
allocation/reclaim
|
|
allocation/hugepages.rst
|