Repository navigation
Document class methods - #9046
Conversation
dstansby
added
Documentation
Release critical
bc7927a to
d4461a8
Compare
Add some more no-index Remove extra method listings Fix Figure example section Escape plot_directive docstring@
44aeb33 to
500b658
Compare
|
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 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 |
|
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 to fix #8701. Currently this throws a lot of warnings which need investigating, but building with
--allowsphinxwarningsresults in correctly documented class pages.