diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2023-01-19 17:03:05 -0700 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2023-02-08 13:28:27 -0700 |
| commit | c404f5d4f0993e9d75a4de5a91280e9cb2419281 (patch) | |
| tree | 2f68fd709a0c3202250e9eadf29f46e55b7d4e8e /Documentation/conf.py | |
| parent | fbabc2eaef9fd761315c0edb2d281e9f3e9db9b7 (diff) | |
docs: Add more information to the HTML sidebar
Add a new sidebar template that creates a more RTD-like "fisheye" view of
the current place in the document hierarchy. It is far from ideal, but
some readers may find it better for navigating through the documentation as
a whole.
Add some CSS trickery as well to make the table of contents less intrusive
when viewing the pages on a small screen.
Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
Reviewed-by: David Gow <davidgow@google.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/conf.py')
| -rw-r--r-- | Documentation/conf.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py index d927737e3c10..6c8ccf3095ac 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -153,7 +153,7 @@ else: math_renderer = 'mathjax' # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ['sphinx/templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -328,6 +328,7 @@ if html_theme == 'alabaster': 'description': get_cline_version(), 'page_width': '65em', 'sidebar_width': '15em', + 'fixed_sidebar': 'true', 'font_size': 'inherit', 'font_family': 'serif', } @@ -345,7 +346,7 @@ html_use_smartypants = False # Custom sidebar templates, maps document names to template names. # Note that the RTD theme ignores this -html_sidebars = { '**': ['searchbox.html', 'localtoc.html', 'sourcelink.html']} +html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']} # about.html is available for alabaster theme. Add it at the front. if html_theme == 'alabaster': |