docs: reconfigure the HTML left column
authorJonathan Corbet <corbet@lwn.net>
Tue, 27 Sep 2022 16:05:55 +0000 (10:05 -0600)
committerJonathan Corbet <corbet@lwn.net>
Thu, 29 Sep 2022 18:55:06 +0000 (12:55 -0600)
Use the html_sidebars directive to get a more useful set of links in the
left column.

Unfortunately, this is a no-op with the default RTD theme, but others
observe it.

Reviewed-by: David Vernet <void@manifault.com>
Acked-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20220927160559.97154-4-corbet@lwn.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/conf.py

index cdcc8e0f46a628448a53b347a486a637098aed08..c45a3b7f7717815ca7aedd7514b6b43927625789 100644 (file)
@@ -369,7 +369,8 @@ html_static_path = ['sphinx-static']
 html_use_smartypants = False
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# Note that the RTD theme ignores this.
+html_sidebars = { '**': ['searchbox.html', 'localtoc.html', 'sourcelink.html']}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.