MAINT: Deploy versioned docs and fix version switcher - #14158
Merged
Merged
Conversation
Member
Author
|
I'll merge this (after fixing the pip-pre failure if needed) and see if it fixes things. I think it should 🤞 |
Member
Author
|
pip-pre is an upstream PyVista error fixed by pyvista/pyvista#8908 . I'll probably merge and continue with this tomorrow! |
larsoner
added a commit
that referenced
this pull request
Aug 15, 2026
… and fix version switcher) [ci skip] (#14159) Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
Member
Author
|
Looks like it worked! 
|
Yann-P
pushed a commit
to pydata/pydata-sphinx-theme
that referenced
this pull request
Sep 18, 2026
Make a `version_match=1.13` work for release `1.13.2`. In `main`, the banner compares the release string against the preferred entry's version, so a patch release of the stable minor shows "unstable development version" unless the JSON version (and hence `version_match`) is rewritten and everything rebuilt for every point release. This has been a stumbling block for multiple projects, namely #1552, #1629, #1908, and now MNE-Python: <img width="1126" height="715" alt="Screenshot 2026-09-16 at 09 49 06" src="https://github.com/user-attachments/assets/fe3aa34a-e175-492b-b67d-c7b55c57e07c" /> (We didn't hit this bug until now because we had our own version-warning script -- which PST's `showVersionWarningBanner` was originally adapted from I think -- that [I removed recently](mne-tools/mne-python#14158) in favor of the theme's banner; that script decided stable vs not from the URL path, i.e. the same identity version_match carries here.) The fix checks `version_match` against the preferred entry before falling back to the release-string comparison, so existing setups are unaffected. The only case in the added test that fails on main is the 1.13.2 / 1.13 row, so other behaviors should hopefully be safely preserved. This is the release vs version fragility described in #1629. With `version_match` checked first, the banner and the switcher agree on what the current version is. But that issue cites other issues like doc clarity so no `Closes` on it I think. It would be great to get this fix into 0.22 if possible! Changes drafted with Claude Fable 5.1 but reviewed / understood by me (even though my JS skills are limited!).
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.
A few things we can do to make our release process simpler:
Symlink
stablerather than copying files (I will do this manually)Fix the
"version"for 1.12 (should be1.12notstable; theme matches version by string equality against the build's version_match). Should fix this just being "choose version" on 1.12 docs:Use the builtin warning banner
Drafted with Claude Fable 5 but I reviewed and revised myself.