diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2026-08-05 13:38:32 -0600 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2026-08-05 13:38:32 -0600 |
| commit | f323851805faa770bf13ad2647abac959b84ac56 (patch) | |
| tree | 1f75a54b4bb4c480dcf9182c49afaa0cacc4a8eb /tools/lib/python | |
| parent | 2a8d68338ee77e200895f2697c56fd00094767f7 (diff) | |
| parent | 5bb9bdaf2cba52820b342179a545f7831103ed1d (diff) | |
Merge branch 'html' into docs-mw
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.
Additionally, make the section titles in the sidebar bold to make them
stand-out.
This makes the overall structure of the documentation clearer from the
sidebar directly.
PS: This is how I've implemented this in the Yocto Project
documentation[1] where I faced the same issue. See also the index.rst
file[2] (which was by the way inspired by the kernel's own index.rst)
and CSS addition[3].
[1]: https://docs.yoctoproject.org/dev/
[2]: https://git.yoctoproject.org/yocto-docs/tree/documentation/index.rst
[3]: https://git.yoctoproject.org/yocto-docs/tree/documentation/sphinx-static/theme_overrides.css#n106
[jc: I tweaked the CSS slightly, any problems there are my fault]
Diffstat (limited to 'tools/lib/python')
0 files changed, 0 insertions, 0 deletions
