Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Document class methods #9046

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Aug 21, 2017
Merged

Document class methods #9046

merged 2 commits into from
Aug 21, 2017

Conversation

dstansby
Copy link
Member

This is an attempt to fix #8701. Currently this throws a lot of warnings which need investigating, but building with --allowsphinxwarnings results in correctly documented class pages.

@dstansby dstansby added Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labels Aug 16, 2017
@dstansby dstansby added this to the 2.1 (next point release) milestone Aug 16, 2017
@dstansby
Don't document class methods on axis/tick api page
500b658 
Add some more no-index

Remove extra method listings

Fix Figure example section

Escape plot_directive docstring@
@dstansby dstansby changed the title [WIP] Document class methods Document class methods Aug 21, 2017
@dstansby
Copy link
Member Author

I think this should now be ready to go. Essentially I've turned on documenting class methods by default, and had to manually disable a few places where they were being duplicated. All the new pages added by @choldgraf should be the same, but I'll double check the circleci build once it is done.

@dstansby
Copy link
Member Author

As an example, here's the current Figure class page: http://matplotlib.org/devdocs/api/_as_gen/matplotlib.figure.Figure.html

and the new one: https://27-74355158-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure

@choldgraf
Copy link
Contributor

this sounds like a good addition to me - I guess Figure is probably going to have one of the longer versions of these new pages, yeah? If you double check that the other pages look good then I think we're good to go

@dstansby
Copy link
Member Author

Just manually checked all the pages I made changes to, and they look the same as before.

@choldgraf choldgraf merged commit 2ed56ab into matplotlib:master Aug 21, 2017
@choldgraf
Copy link
Contributor

boom!

@tacaswell
Copy link
Member

Thanks @dstansby ! This is something I had been dreading fixing!

@dstansby dstansby deleted the class-methods branch August 21, 2017 19:44
@dstansby
Copy link
Member Author

It took me a while to understand the warnings, but I got there eventually (and learnt a bit more about sphinx along the way!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Milestone
v2.1
Development

Successfully merging this pull request may close these issues.

Class pages don't document their methods
3 participants
@dstansby @choldgraf @tacaswell