Skip to content
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

Remove versions from sidebar in docs #27895

Merged
merged 1 commit into from
Mar 10, 2024
Merged

Conversation

dstansby
Copy link
Member

@dstansby dstansby commented Mar 9, 2024

My reasoning here is:

  • There is now a version switcher in the top right, as part of the pyadata-sphinx-theme.
  • The only other thing the versions in the sidebar adds is a note about the last supported version for Python 2, but Python 2 is long end of life, so I think fine to remove this.
  • Removing the versions from the sidebar removes a location where the version has to be manually updated every time a new release is done (e.g., [Doc]: Latest stable version in sidebar out of date #27863).

@github-actions github-actions bot added the Documentation: build building the docs label Mar 9, 2024
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To prevent outdated information in the older docs, which still show this sidebar, I suggest to modify versions.html so that it does not show the version number for latest anymore:

grafik

and link docs and release notes to https://matplotlib.org/stable/

@timhoffm
Copy link
Member

timhoffm commented Mar 9, 2024

This PR should also remove the sentence

You will need to manually edit versions.html to show the released version.

from https://matplotlib.org/devdocs/devel/release_guide.html#build-and-deploy-documentation.

@github-actions github-actions bot added the Documentation: devdocs files in doc/devel label Mar 10, 2024
@timhoffm timhoffm merged commit cc83b59 into matplotlib:main Mar 10, 2024
31 of 34 checks passed
@dstansby dstansby deleted the sidebar-vers branch March 10, 2024 13:55
@QuLogic QuLogic added this to the v3.9.0 milestone Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: build building the docs Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants