mirrors/linux
2
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2026-08-28 23:55:20 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: html: show sections in the sidebar

Browse Source 
The current sidebar in the HTML version of the documentation does not
display the section titles because the toctree directives in the
top-level index.rst document do not contain ":caption:" properties.
Replacing the current section titles by ":caption:" properties would not
allow having text between those and the table of contents.

To workaround this issue, add the ":caption:" properties in the toctree
calls which makes them show up in the sidebar, but hide them from the
index page with a custom CSS addition.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260804-show-sections-in-sidebar-v2-1-a68d23bbc79d@bootlin.com>
This commit is contained in:
Antonin Godard
2026-08-04 17:59:34 +02:00
committed by Jonathan Corbet
parent 2a8d68338e
commit 29d58caf95
2 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/index.rst
View File

@@ -21,6 +21,7 @@ community and getting your work upstream.
.. toctree::
:maxdepth: 1
:caption: Working with the development community
Development process <process/development-process>
Submitting patches <process/submitting-patches>
@@ -37,6 +38,7 @@ kernel.
.. toctree::
:maxdepth: 1
:caption: Internal API manuals
Core API <core-api/index>
Driver APIs <driver-api/index>
@@ -50,6 +52,7 @@ Various other manuals with useful information for all kernel developers.
.. toctree::
:maxdepth: 1
:caption: Development tools and processes
Licensing rules <process/license-rules>
Writing documentation <doc-guide/index>
@@ -71,6 +74,7 @@ developers seeking information on the kernel's user-space APIs.
.. toctree::
:maxdepth: 1
:caption: User-oriented documentation
Administration <admin-guide/index>
Build system <kbuild/index>
@@ -88,6 +92,7 @@ platform firmware.
.. toctree::
:maxdepth: 1
:caption: Firmware-related documentation
Firmware <firmware-guide/index>
Firmware and Devicetree <devicetree/index>
@@ -98,6 +103,7 @@ Architecture-specific documentation
.. toctree::
:maxdepth: 2
:caption: Architecture-specific documentation
CPU architectures <arch/index>
@@ -111,6 +117,7 @@ to reStructuredText format, or are simply too old.
.. toctree::
:maxdepth: 1
:caption: Other documentation
Unsorted documentation <staging/index>
@@ -120,6 +127,7 @@ Translations
.. toctree::
:maxdepth: 2
:caption: Translations
Translations <translations/index>

6
Documentation/sphinx-static/custom.css
View File

@@ -77,6 +77,12 @@ div.kerneltoc li.current ul { margin-left: 0; }
div.kerneltoc { background-color: #eeeeee; }
div.kerneltoc li.current ul { background-color: white; }
/*
* Hide toctree captions on the welcome page, they should only be shown in the
* sidebar.
*/
section#the-linux-kernel-documentation p.caption { display: none; }
/*
* The CSS magic to toggle the contents on small screens.
*/