From abe447910a0687cbb1029ac96caf90454d95a745 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Fri, 16 Feb 2024 22:40:14 +0100 Subject: [PATCH] Deactivate sidebar for release notes The release note page is only a structured collection of links to sub-pages. The sidebar would repeat all the titles of the sub-pages and thus basically repeat all the content of the page. Even worse, it does not contain the version sectioning structure of the release notes page itself. To keep the layout the sidebar gets one empty dummy section. If we leave the sidebar completely empty, it will be deactivated and change the layout of the page. Related to https://github.com/matplotlib/matplotlib/pull/27690#issuecomment-1907277251 --- doc/_templates/empty_sidebar.html | 1 + doc/conf.py | 4 ++++ 2 files changed, 5 insertions(+) create mode 100644 doc/_templates/empty_sidebar.html diff --git a/doc/_templates/empty_sidebar.html b/doc/_templates/empty_sidebar.html new file mode 100644 index 000000000000..2ebb29fad4dd --- /dev/null +++ b/doc/_templates/empty_sidebar.html @@ -0,0 +1 @@ +
diff --git a/doc/conf.py b/doc/conf.py index 3805facbfbcc..ccde74304eb3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -536,6 +536,10 @@ def js_tag_with_cache_busting(js): "cheatsheet_sidebar.html", "donate_sidebar.html", ], + # no sidebar for release notes, because that page is only a collection of links + # to sub-pages. The sidebar would repeat all the titles of the sub-pages and + # thus basically repeat all the content of the page. + "users/release_notes": ["empty_sidebar.html"], # '**': ['localtoc.html', 'pagesource.html'] }