Use template to set sidebar

Author: ConorMacBride

.github/workflows/docs.yml

@@ -52,7 +52,7 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./docs/_build/html
-          exclude_assets: '.buildinfo'
+          exclude_assets: '.buildinfo,_static/jquery-*.js,_static/underscore-*.js'
           destination_dir: ./latest
           keep_files: false
           full_commit_message: Deploy latest to GitHub Pages

.gitignore

@@ -9,3 +9,6 @@ __pycache__
 build
 dist
 .tmp
+.DS_Store
+/docs/sample
+/docs/_build

docs/_templates/mpl_third_party_sidebar.html

@@ -0,0 +1,8 @@
+<nav class="bd-links" id="bd-docs-nav" aria-label="{{ _('Site navigation') }}">
+  <p class="bd-links__title" role="heading" aria-level="1">
+    <a href="{{ pathto('index') }}">{{ project }} Documentation</a>
+  </p>
+  <div class="bd-toc-item navbar-nav">
+    {{ generate_toctree_html("sidebar", startdepth=0, maxdepth=1, collapse=True, includehidden=True, titles_only=True) }}
+  </div>
+</nav>

docs/conf.py

@@ -38,7 +38,6 @@
 # ones.
 extensions = [
     'sample_summaries',
-    'sidebar',
     'sphinx_design',
 ]
 
@@ -58,13 +57,18 @@
 #
 html_theme = "mpl_sphinx_theme"
 html_theme_options = {
-    "native_site": False,
+    "navbar_links": "absolute",
     "show_prev_next": False,
-    "logo": {"image_light": "images/logo2.svg",
+    "logo": {"link": "https://matplotlib.org/stable/",
+             "image_light": "images/logo2.svg",
              "image_dark": "images/logo_dark.svg"},
+    "collapse_navigation": False,
+}
+html_sidebars = {
+    "**": ["mpl_third_party_sidebar.html", "sidebar-nav-bs.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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']

docs/index.rst

@@ -3,7 +3,6 @@
 .. module:: pytest-mpl
 
 .. toctree::
-    :caption: pytest-mpl Documentation
     :hidden:
 
     installing