Enable version warning banners for docs #7139
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
If the doc version isn't the preferred one, a warning banner is shown at the top. This also accounts for dev builds.
lagru
added
the
📄 type: Documentation
0.14.1 fixes a broken version comparison in the javascript of the version warning banner. See pydata/pydata-sphinx-theme#1446 for more.
|
Should be ready to review / merge. For reviewers: the updated |
lagru
commented
Sep 22, 2023
| { | ||
| "name": "PyPI", | ||
| "url": "https://pypi.org/project/scikit-image/", | ||
| "icon": "fa-solid fa-box", | ||
| }, | ||
| ], | ||
| "navbar_align": "left", |
There was a problem hiding this comment.
This and the added / removed configuration in "icon_links" and "github_url" accounts for some updates between 0.13 and 0.14.
soupault
approved these changes
Sep 22, 2023
jarrodmillman
approved these changes
Sep 22, 2023
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.
Description
If the doc version isn't the preferred one, a warning banner is shown at the top. This also accounts for dev builds.
Blocked until
pydata/pydata-sphinx-theme#1450pydata/pydata-sphinx-theme#1446 is resolved and merged.Partially addresses #7138.
Checklist
For reviewers: see #7139 (comment)
./doc/examplesfor new featuresRelease note
Summarize the introduced changes in the code block below in one or a few sentences. The
summary will be included in the next release notes automatically: