Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Remove "Past versions" section from release notes#27690
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This came in viamatplotlib#21251 and I vaguely remember it hada purpose (possibly something with navigation / whatis rendered in the sidebars?) However, in thecurrent 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. 😬 |
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.
Will give@jklymak chance to chime in, but this looks like a "maintained version" marker that we don't bother to update and therefore I agree on removing it.
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 tohttps://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 openedpydata/pydata-sphinx-theme#1680 to find out whether there's a solution to the sidebar mess. |
The release note page is only a structured collection of links tosub-pages. The sidebar would repeat all the titles of the sub-pages andthus basically repeat all the content of the page. Even worse, it doesnot contain the version sectioning structure of the release notes pageitself. It's thus best to deactivate the sidebar here.Related tomatplotlib#27690 (comment)
The release note page is only a structured collection of links tosub-pages. The sidebar would repeat all the titles of the sub-pages andthus basically repeat all the content of the page. Even worse, it doesnot contain the version sectioning structure of the release notes pageitself. To keep the layout the sidebar gets one empty dummy section.If we leave the sidebar completely empty, it will be deactivated andchange the layout of the page.Related tomatplotlib#27690 (comment)
The release note page is only a structured collection of links tosub-pages. The sidebar would repeat all the titles of the sub-pages andthus basically repeat all the content of the page. Even worse, it doesnot contain the version sectioning structure of the release notes pageitself. To keep the layout the sidebar gets one empty dummy section.If we leave the sidebar completely empty, it will be deactivated andchange the layout of the page.Related tomatplotlib#27690 (comment)
The release note page is only a structured collection of links tosub-pages. The sidebar would repeat all the titles of the sub-pages andthus basically repeat all the content of the page. Even worse, it doesnot contain the version sectioning structure of the release notes pageitself. To keep the layout the sidebar gets one empty dummy section.If we leave the sidebar completely empty, it will be deactivated andchange the layout of the page.Related tomatplotlib#27690 (comment)
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?