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

Move TOC back to top in axes documentation #11907

Merged
merged 1 commit into from Aug 22, 2018

Conversation

timhoffm
Copy link
Member

PR Summary

The TOC in https://matplotlib.org/devdocs/api/axes_api.html is burried somewhere below the class doumentation.

This PR brings the TOC back to top and thus increases its usability.

As a remark: Since #11454 the scope of this page has changed from the Axes class to the Axes module. IMO the class docstring should be moved to a sub-page as well. It's the only content part of the page whereas everything else is just a collection of links. But that's something for another PR.

@timhoffm timhoffm added this to the v3.0 milestone Aug 21, 2018
@timhoffm
Copy link
Member Author

I would really like to see this still go in 3.0. Please re-milestone if that's not feasible.

Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

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

Great - this was bugging me too, but I wasn't sure how to fix...

@jklymak
Copy link
Member

jklymak commented Aug 21, 2018

Should this be back ported to 2.2.x? I'm not quite sure how far back the axes changes went...

@tacaswell tacaswell merged commit 828468d into matplotlib:master Aug 22, 2018
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Aug 22, 2018
jklymak added a commit that referenced this pull request Aug 22, 2018
@timhoffm timhoffm deleted the doc-axes-toc branch August 22, 2018 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants