Experimental: swap sidebars in theme.

rossbar · rossbar · commit 0fd85066a62d · 2021-02-25T15:57:43.000-08:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -133,11 +133,14 @@
 
 html_theme = "pydata_sphinx_theme"
 html_theme_options = {
-    "github_url": "https://github.com/numpy/numpydoc"
+    "github_url": "https://github.com/numpy/numpydoc",
 }
 
 html_title = "%s v%s Manual" % (project, version)
 html_last_updated_fmt = '%b %d, %Y'
+html_sidebars = {
+    "**": ["sidebar-search-bs.html", "docs-toc.html"],
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
diff --git a/doc/example.rst b/doc/example.rst
@@ -1,3 +1,7 @@
+.. NOTE: The :notoc: metadata is used to suppress the right-sidebar in the
+   pydata-sphinx-theme.
+
+:notoc:
 
 .. _example:
 
diff --git a/doc/format.rst b/doc/format.rst
@@ -1,3 +1,7 @@
+.. NOTE: The :notoc: metadata is used to suppress the right-sidebar in the
+   pydata-sphinx-theme.
+
+:notoc:
 
 .. _format:
 
diff --git a/doc/install.rst b/doc/install.rst
@@ -1,3 +1,7 @@
+.. NOTE: The :notoc: metadata is used to suppress the right-sidebar in the
+   pydata-sphinx-theme.
+
+:notoc:
 
 ============
 Installation
diff --git a/doc/release_notes.rst b/doc/release_notes.rst
@@ -1,3 +1,8 @@
+.. NOTE: The :notoc: metadata is used to suppress the right-sidebar in the
+   pydata-sphinx-theme.
+
+:notoc:
+
 Release notes
 =============
 
diff --git a/doc/validation.rst b/doc/validation.rst
@@ -1,3 +1,8 @@
+.. NOTE: The :notoc: metadata is used to suppress the right-sidebar in the
+   pydata-sphinx-theme.
+
+:notoc:
+
 ==============================
 Validating NumpyDoc docstrings
 ==============================
