Skip to content

docs: render captioned sidebar sections for versioned user guides #4699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andygrove wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: render captioned sidebar sections for versioned user guides #4699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/source/_templates/docs-sidebar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@
-->

{# Start the sidebar from the deepest captioned section the page lives under:
- user-guide/latest/* lives under user-guide/index.md → user-guide/latest/index.rst, so start at depth 2
- user-guide/<version>/* (latest or a released version like 0.17) lives under
user-guide/index.md → user-guide/<version>/index.rst, so start at depth 2
- contributor-guide/* lives under contributor-guide/index.md, so start at depth 1
- root and orphan pages (search, genindex) fall back to the global toctree (depth 0). #}
{% if pagename.startswith("user-guide/latest/") and not suppress_sidebar_toctree(startdepth=2, includehidden=True) %}
{% if pagename.startswith("user-guide/") and pagename.split("/")|length > 2 and not suppress_sidebar_toctree(startdepth=2, includehidden=True) %}
{% set sidebar_startdepth = 2 %}
{% elif not suppress_sidebar_toctree(startdepth=1, includehidden=True) %}
{% set sidebar_startdepth = 1 %}
Expand Down