DOC: add placeholder for announcement banner in docs (and use for 3.0rc announcement) #63282
+2
−0
Conversation
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
Member
Author
|
And because it is set up with a URL (not hardcoded text in the docs itself), once this is included on the hosted docs, you can change or disable (with empty file) the banner by changing the template file in the main repo, without having to rebuild the docs. |
mroeschke
reviewed
Dec 8, 2025
Member
mroeschke
left a comment
mroeschke
left a comment
There was a problem hiding this comment.
I'm +0.5 on including this. Personally, the banner appearing on every page of the docs without a way for visitors to suppress it is a shame, but the announcement is important for us
| @@ -0,0 +1 @@ | |||
| Announcement: pandas 3.0 release candidate is now available! Read more <a href="https://pandas.pydata.org/docs/whatsnew/v3.0.0.html">here</a>. Please test! No newline at end of file | |||
Member
There was a problem hiding this comment.
Should the URL point to https://pandas.pydata.org/docs/dev/whatsnew/v3.0.0.html instead? Visiting https://pandas.pydata.org/docs/whatsnew/v3.0.0.html directly 404's for me
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Would have to refine the actual message for right now, but general idea is that it would look like this:
The banner disappears once you scroll down, but is otherwise always visible (there is no "x" to click it away). You can see a live version of it on the theme docs: https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html
Thoughts?