-
-
Notifications
You must be signed in to change notification settings - Fork 10.9k
DOC: numpy. 2.0 documentation shows red in the version pulldown #27248
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
Comments
The pulldown button has this html for the 2.0 documentation
We have this CSS styling in
The theme documentation mentions the top CSS stanza, but not the second one. I don't know why #26125 enabled that stanza. It was applied to the 2.0 documentation but not activated due to the logic, but now that the 2.0 documentation is no longer "stable" the styling is activated. I submitted numpy/doc#27 to comment it out (waiting for review), but still do not understand what the motivation for making a version red. @tupui I think this was added in #21451? Another point, the devdoc button has this html:
So the CSS attribute does not match the first selector. I think that is due to the
|
Rather than fix the css selectors, another option would be to delete them and not attempt to colrize the button. We do have the header |
What is the special significance of this combinations that justifies coloring the button red for older versions?
|
This is debatable of course. It's just to incentivize more people to use latest always know if what they are looking at is the latest version of the doc. Some blogs or tutorials link to a specific version and people could not realize that something is deprecated/legacy. |
Just a note that it should also be possible to use the version warning for old versions using https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/announcements.html#version-warning-banners (I'm not sure why it seems that was disabled for the 2.0 docs) This is an example of how it shows (very similar to the warning for the dev version: https://pydata-sphinx-theme.readthedocs.io/en/v0.14.4/user_guide/announcements.html) |
Enabling/disabling the warning is not part of the documentation build instructions. What must be done to enable the warning? In the mean time, until we resolve whether we want the 2.0 docs to be red, I merged numpy/doc#27 to disable the red styling. |
I see that the option is enabled in our conf.py: Line 265 in 83cd89b
|
Note: numpy/doc#27 undid the coloring for the 2.0 docs. But the setting is included in the 2.1 and 2.2 docs. 2.1 is already red, and 2.2 will be once the 2.3 docs are up. |
Issue with current documentation:
I uploaded 2.1 documentation. Now the version pulldown in the 2.0 documentation is showing red for 2.0. This is coming from #26125 (hi @melissawm) which un-commented the relevant css
Idea or request for content:
I don't understand
data-active-version-name
comes from?The text was updated successfully, but these errors were encountered: