-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC: condense version switcher #22263
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
DOC: condense version switcher #22263
Conversation
Also, this would be where we decide if we want stable/latest or devdocs/dev |
Marking as release critical. If we do nothing, we'll have a version switcher with a very long text for the dev branch in the next release. |
Isn't this about the number of entries, not the dev entry? |
Yes, I was more referring to additional work on the version switcher proposed above.
We can separate these discussions if we have agreement on one topic, but not on the other, but we shouldn't forget them. |
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 like dropping the patch version from the dropdown menu and leaving it only at minor versions. Perhaps also drop the "3.5.1 (stable)" and make it "3.5 (stable)"?
3.6 (dev) sounds better to me, we know they are docs already. (Python docs have the order switched to "(dev) 3.6", I'm indifferent on the order)
Do we want to have the version switcher able to go back to 1.x versions? That also adds quite a bit of length to the selector.
The Python docs skip the older versions, going as 2.7, 3.5, 3.6, ... . Perhaps keep only the most recent 2.x version in the dropdown?
I think keeping it as compact as possible makes sense. Folks can still always find their version manually. |
I think what @greglucas suggested seems reasonable. |
This commit just has 3.5, 3.6, 3.4, 3.3, 2.2, and 1.5 Remove 1.5 as well? |
I think 1.5 can go as well. |
Fixed.... |
28d8afd
to
cc93f01
Compare
cc93f01
to
611d428
Compare
PR Summary
This just makes the version switcher shorter...
Note skipping CI because there is nothing to test here.
PR Checklist
Tests and Styling
pytest
passes).flake8-docstrings
and runflake8 --docstring-convention=all
).Documentation
doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).