docs: Fix version warning banner #1088
Merged
Conversation
This file contains 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
augustebaum
suggested changes
Jan 13, 2025
augustebaum
approved these changes
Jan 13, 2025
rouk1
pushed a commit
that referenced
this pull request
Jan 14, 2025
There is a bug in documentation when releasing a new version X.Y.Z with Z `>0`. It shows the warning banner indicating that it's a development version, even if it's really a release version. It is because, to know if the banner must be showed, the release version X.Y.Z is currently compared to the previous X.Y, instead of X.Y.Z. When Z is `>0`, X.Y.Z is always greater than X.Y, so sphinx consider it's a unstable version. > If the version compares greater than the preferred version (or if the version match contains the strings “dev”, “rc” or “pre”), the announcement will say they are viewing an unstable development version instead. https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/announcements.html --- This PR intends to compare current strict release with the previous strict release to know if the banner must be showed, instead of the MAJOR.MINOR. Closes #1058.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There is a bug in documentation when releasing a new version X.Y.Z with Z
>0.It shows the warning banner indicating that it's a development version, even if it's really a release version.
It is because, to know if the banner must be showed, the release version X.Y.Z is currently compared to the previous X.Y, instead of X.Y.Z. When Z is
>0, X.Y.Z is always greater than X.Y, so sphinx consider it's a unstable version.https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/announcements.html
This PR intends to compare current strict release with the previous strict release to know if the banner must be showed, instead of the MAJOR.MINOR.
Closes #1058.