diff --git a/docs/_templates/custom-template.html b/docs/_templates/custom-template.html new file mode 100644 index 000000000..aaf11cec2 --- /dev/null +++ b/docs/_templates/custom-template.html @@ -0,0 +1,6 @@ +
\ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 3e6ed5011..6fec3bfb7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,6 +49,9 @@ # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +html_sidebars = { + "contributing": ["sidebar-search-bs.html", "custom-template.html"], +} # -- Options for HTML output ------------------------------------------------- diff --git a/docs/user_guide/configuring.rst b/docs/user_guide/configuring.rst index 06a1a8a88..3dbfa121b 100644 --- a/docs/user_guide/configuring.rst +++ b/docs/user_guide/configuring.rst @@ -48,6 +48,17 @@ an external site. You can add external links to the nav bar like so: ] } +Configure the sidebar +===================== + +``pydata_sphinx_theme`` provides two new sidebar items by default: + +- ``sidebar-nav-bs.html`` - a bootstrap-friendly navigation section +- ``sidebar-search-bs.html`` - a bootstrap-friendly search bar + +By default, this theme's sidebar has these two elements in it. If you'd like to +override this behavior and control the sidebar on a per-page basis, use the +`Sphinx html-sidebars configuration value