-
-
Notifications
You must be signed in to change notification settings - Fork 19.4k
DOC: add placeholder for announcement banner in docs (and use for 3.0rc announcement) #63282
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
DOC: add placeholder for announcement banner in docs (and use for 3.0rc announcement) #63282
Conversation
|
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
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, indeed (it was just some quick content, should still have to wordsmith and format an actual messsage)
It would have been nicer that it is "dismissible" indeed .. But if we only show it for a few weeks, I think that is OK? Or at least worth a try. As I mentioned, we can always easily disable it by committing something to main |
|
There is pydata/pydata-sphinx-theme#1384 about making it dismissable, but that is not yet implemented. But it is done for the version banner (pydata/pydata-sphinx-theme#1763), maybe I can reuse some parts there to add some javascript on our side to add a close button. |
mroeschke
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah just sharing a non-blocking opinion. OK with the banner generally
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?