Add sphinx-multiversion for firmware version-based docs#6
Closed
YanNaingWinn wants to merge 2 commits into
Closed
Conversation
Integrates sphinx-multiversion so each card firmware version (v1.6.1,
v1.6.2, …) gets its own docs at docs.cryptnox.com/{version}/. Users can
switch between versions via a dropdown in the RTD sidebar.
- requirements.txt: add sphinx-multiversion dependency
- conf.py: configure smv_* whitelist/pattern settings
- deploy.yml: build all versions; root redirect falls back to latest
version branch when no tags exist
- _templates/versioning.html: version selector dropdown UI
- _templates/layout.html: inject version selector into footer block
- docs/make.bat: Windows Sphinx build helper
- README.md: document versioning workflow and URL structure
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
sphinx-multiversion 0.2.4 is incompatible with Sphinx 8.x (Config.read() signature change). Pin to Sphinx 7.x until a compatible version is available. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
sphinx-multiversionso each card firmware version (e.g.,v1.6.1) gets its own docs atdocs.cryptnox.com/{version}/docs.cryptnox.comredirects automatically to the latest released version branchChanges
requirements.txtsphinx-multiversiondocs/source/conf.pysmv_*whitelist/pattern settings.github/workflows/deploy.ymlsphinx-multiversionbuild; added smart root redirect that checks version branches then falls back tomaindocs/source/_templates/versioning.htmldocs/source/_templates/layout.htmldocs/make.batREADME.mdHow to activate after merge
After this PR merges to
main, create and push the first version branch to make the selector live:git checkout main && git pull git checkout -b v1.6.1 git push origin v1.6.1CI will then build both
main/andv1.6.1/and the version dropdown will appear in the sidebar.Test plan
mainv1.6.1branch and push_site/main/and_site/v1.6.1/docs.cryptnox.comredirects todocs.cryptnox.com/v1.6.1/Closes #
🤖 Generated with Claude Code