feat(docs): versioned Sphinx docs with sphinx-multiversion#89
Open
rederik76 wants to merge 1 commit into
Open
Conversation
Collaborator
rederik76
commented
May 23, 2026
rederik76
commented
- Add sphinx-multiversion to requirements-docs.txt; fix sphinx-autoapi package name (was gitsphinx-autoapi — typo)
- docs/conf.py: read release from VERSION file instead of hard-coded string; add sphinx_multiversion extension with SMV_TAG_WHITELIST env-var-driven tag filter; inject versions.html into RTD sidebar via html_sidebars
- docs/select_versions.py: CI helper that selects tags to build — latest patch of each major version + last 5 minor series; writes SMV_TAG_WHITELIST to $GITHUB_ENV
- docs/_templates/versions.html: RTD-styled version dropdown template using sphinx-multiversion's versions / current_version context
- main-docs.yml: trigger on tag pushes; fetch full history and tags; run select_versions.py before build; replace make html with sphinx-multiversion; add root index.html redirect to main/
- Add sphinx-multiversion to requirements-docs.txt; fix sphinx-autoapi package name (was gitsphinx-autoapi — typo) - docs/conf.py: read release from VERSION file instead of hard-coded string; add sphinx_multiversion extension with SMV_TAG_WHITELIST env-var-driven tag filter; inject versions.html into RTD sidebar via html_sidebars - docs/select_versions.py: CI helper that selects tags to build — latest patch of each major version + last 5 minor series; writes SMV_TAG_WHITELIST to $GITHUB_ENV - docs/_templates/versions.html: RTD-styled version dropdown template using sphinx-multiversion's versions / current_version context - main-docs.yml: trigger on tag pushes; fetch full history and tags; run select_versions.py before build; replace make html with sphinx-multiversion; add root index.html redirect to main/
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.