diff options
| author | Antonin Godard <antonin.godard@bootlin.com> | 2026-08-04 17:59:34 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2026-08-05 13:04:26 -0600 |
| commit | 29d58caf95e9dc2cc5e751e7ead414e32dce8386 (patch) | |
| tree | bb39f2187995bdaddab7c89b432150070fa3e773 /tools/lib/python | |
| parent | 2a8d68338ee77e200895f2697c56fd00094767f7 (diff) | |
Documentation: html: show sections in the sidebar
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>
Diffstat (limited to 'tools/lib/python')
0 files changed, 0 insertions, 0 deletions
