Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
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.
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
Add some more no-indexRemove extra method listingsFix Figure example sectionEscape plot_directive docstring@
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. |
As an example, here's the current |
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 |
Just manually checked all the pages I made changes to, and they look the same as before. |
boom! |
Thanks@dstansby ! This is something I had been dreading fixing! |
It took me a while to understand the warnings, but I got there eventually (and learnt a bit more about sphinx along the way!) |
This is an attempt tofix#8701. Currently this throws a lot of warnings which need investigating, but building with
--allowsphinxwarningsresults in correctly documented class pages.