Deactivate sidebar for release notes

timhoffm · timhoffm · commit abe447910a06 · 2024-02-18T22:28:19.000+01:00
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 #27690 (comment)
diff --git a/doc/_templates/empty_sidebar.html b/doc/_templates/empty_sidebar.html
@@ -0,0 +1 @@
+<div class="sidebar-empty"></div>
diff --git 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']
 }
 
