Skip to content

Enable versioned documentation #2276

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

Merged
ndgrigorian merged 9 commits into from
Apr 12, 2026
Merged

Enable versioned documentation #2276

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5d2439e
change doc versions listed in doc_versions.txt
ndgrigorian Apr 10, 2026
2ec6aa2
add --multiversion option to gen_docs.py and use in doc generation
ndgrigorian Apr 10, 2026
2dab64c
add logic to find doc_versions.txt
ndgrigorian Apr 10, 2026
62d166e
add custom sidebar element for versions
ndgrigorian Apr 10, 2026
56294ea
if docs version can't be determined, default to displaying latest
ndgrigorian Apr 10, 2026
9f5ac60
add gh-2276 to changelog
ndgrigorian Apr 10, 2026
3e9a41f
move latest to top of doc_versions
ndgrigorian Apr 10, 2026
a2ffa9b
use release for multiversioned documentation current_version context
ndgrigorian Apr 10, 2026
c246294
drop unnecessary step in generate-docs workflow
ndgrigorian Apr 10, 2026
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
Prev Previous commit
Next Next commit
add custom sidebar element for versions
  • Loading branch information
@ndgrigorian
ndgrigorian committed Apr 10, 2026
commit 62d166ef5abe49950c69bf3a299e5a7c8436408c
32 changes: 11 additions & 21 deletions docs/doc_sources/_templates/versions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,12 @@
{% if READTHEDOCS or display_lower_left %}
{# Add rst-badge after rst-versions for small badge style. #}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Other versions</span>
v: {{ current_version }}
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
{% if versions|length >= 1 %}
<dl>
<dt>{{ _('Versions') }}</dt>
{% for slug, url in versions %}
{% if slug == current_version %} <strong> {% endif %}
<dd><a href="{{ url }}">{{ slug }}</a></dd>
{% if slug == current_version %} </strong> {% endif %}
{% endfor %}
</dl>
{% endif %}
</div>
</div>
{% if display_lower_left %}
<div class="sidebar-versions" style="padding: 1em; border-top: 1px solid var (--color-sidebar-brand-text);">
<strong>Docs Version</strong>
<select onchange="window.location.href=this.value" style="width: 100%; margin-top: 0.5em; padding: 0.25em;">
{% for slug, url in versions %}
<option value="{{ url }}" {% if slug==current_version %}selected{% endif %}>
{{ slug }}
</option>
{% endfor %}
</select>
</div>
{% endif %}
12 changes: 12 additions & 0 deletions docs/doc_sources/conf.py.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,15 @@ if generate_multiversion == "ON":
html_context["versions"].append(
(version, DOC_SITE_NAME + version + "/index.html")
)

html_sidebars = {
"**": [
"sidebar/scroll-start.html",
"sidebar/brand.html",
"sidebar/search.html",
"versions.html",
"sidebar/navigation.html",
"sidebar/ethical-ads.html",
"sidebar/scroll-end.html",
]
}
Loading