Skip to content

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

Merged
merged 1 commit into from
Mar 29, 2022

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Jan 19, 2022

PR Summary

This just makes the version switcher shorter...

Note skipping CI because there is nothing to test here.

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@jklymak jklymak added the Documentation: website layout/behavior/styling changes label Jan 19, 2022
@jklymak
Copy link
Member Author

jklymak commented Jan 19, 2022

Also, this would be where we decide if we want stable/latest or devdocs/dev

@jklymak jklymak added this to the v3.6.0 milestone Feb 1, 2022
@timhoffm timhoffm added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Feb 7, 2022
@timhoffm
Copy link
Member

timhoffm commented Feb 7, 2022

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.

@QuLogic
Copy link
Member

QuLogic commented Feb 8, 2022

Isn't this about the number of entries, not the dev entry?

@timhoffm
Copy link
Member

timhoffm commented Feb 8, 2022

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.

Also, this would be where we decide if we want stable/latest or devdocs/dev

We can separate these discussions if we have agreement on one topic, but not on the other, but we shouldn't forget them.

Copy link
Contributor

@greglucas greglucas left a 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?

@jklymak
Copy link
Member Author

jklymak commented Feb 12, 2022

I think keeping it as compact as possible makes sense. Folks can still always find their version manually.

@QuLogic
Copy link
Member

QuLogic commented Feb 16, 2022

I think what @greglucas suggested seems reasonable.

@jklymak
Copy link
Member Author

jklymak commented Feb 21, 2022

This commit just has 3.5, 3.6, 3.4, 3.3, 2.2, and 1.5 Remove 1.5 as well?

@timhoffm
Copy link
Member

I think 1.5 can go as well.

@jklymak
Copy link
Member Author

jklymak commented Mar 28, 2022

Fixed....

@jklymak jklymak force-pushed the doc-version-switcher-condense branch from 28d8afd to cc93f01 Compare March 28, 2022 12:25
@jklymak jklymak force-pushed the doc-version-switcher-condense branch from cc93f01 to 611d428 Compare March 28, 2022 12:27
@timhoffm timhoffm merged commit f670fe7 into matplotlib:main Mar 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: website layout/behavior/styling changes Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants