Remove "Past versions" section from release notes #27690
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This came in via matplotlib#21251 and I vaguely remember it had a purpose (possibly something with navigation / what is rendered in the sidebars?) However, in the current docs, it looks rather useless. https://matplotlib.org/devdocs/users/release_notes.html
|
That PR was milestoned for 3.5, so the past version sets off every release before then...looks like we don't ever move it though like I think we were supposed to. 😬 |
|
I think it was because the left-hand navigation ends up a huge wall of text. But I don't feel strongly about it. |
|
The section does not influence the left sidebar. According to https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/layout.htmlthe sidebar contains links between pages in the active section, which is "Release notes " here. So the only way of reducing the wall would be to reorganize the sub pages. |
|
I'm merging because the sectioning does not help. I've opened pydata/pydata-sphinx-theme#1680 to find out whether there's a solution to the sidebar mess. |
timhoffm
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Feb 16, 2024
The release note page is only a structured collection of links to sub-pages. The sidebar would repeat all the titles of the sub-pages and thus basically repeat all the content of the page. Even worse, it does not contain the version sectioning structure of the release notes page itself. It's thus best to deactivate the sidebar here. Related to matplotlib#27690 (comment)
timhoffm
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Feb 18, 2024
The release note page is only a structured collection of links to sub-pages. The sidebar would repeat all the titles of the sub-pages and thus basically repeat all the content of the page. Even worse, it does not contain the version sectioning structure of the release notes page itself. To keep the layout the sidebar gets one empty dummy section. If we leave the sidebar completely empty, it will be deactivated and change the layout of the page. Related to matplotlib#27690 (comment)
Impaler343
pushed a commit
to Impaler343/matplotlib
that referenced
this pull request
Mar 8, 2024
The release note page is only a structured collection of links to sub-pages. The sidebar would repeat all the titles of the sub-pages and thus basically repeat all the content of the page. Even worse, it does not contain the version sectioning structure of the release notes page itself. To keep the layout the sidebar gets one empty dummy section. If we leave the sidebar completely empty, it will be deactivated and change the layout of the page. Related to matplotlib#27690 (comment)
Impaler343
pushed a commit
to Impaler343/matplotlib
that referenced
this pull request
Mar 14, 2024
The release note page is only a structured collection of links to sub-pages. The sidebar would repeat all the titles of the sub-pages and thus basically repeat all the content of the page. Even worse, it does not contain the version sectioning structure of the release notes page itself. To keep the layout the sidebar gets one empty dummy section. If we leave the sidebar completely empty, it will be deactivated and change the layout of the page. Related to matplotlib#27690 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This came in via #21251 and I vaguely remember it had a purpose (possibly something with navigation / what is rendered in the sidebars?) However, in the
current docs, it looks rather useless: https://matplotlib.org/devdocs/users/release_notes.html
Ping @jklymak do you remember why you added a "Past versions" section?