Don't generate individual doc entries for inherited Axes/Axis/Tick methods #14960
Conversation
|
IIRC, I added these to make sure that we had targets for the auto-reference links sphinx will generate. |
|
Does sphinx not link to the parent class as necessary? Well, we can always wait for #14768 to be merged first and we'll see whether this PR breaks the doc build. |
34720c9 to
4b04e2f
Compare
bc18ac4 to
a4c914f
Compare
|
Had to fix just a couple of missing references: Axis refers to its axes property but that's something that numpydoc does automatically and can't be tuned; I also changed the auto-rst table gen to link to the correct parent method which provides the docstring, when it is inherited. |
9a0bde7 to
8e5a042
Compare
|
I am sold on making those pages more readable (by including less noise). Slightly concerned about bit rot / overlapping docs if we remove these build products that problem is already. 👍, but we need to rebuild the missing references. |
|
rebased |
|
This looks about ready, but all the doc builds failing is probably not good... |
…thods.
These methods directly pass through to the superclass and don't warrant
their own page (having a doc page for Tick.add_callback that just
reproes the docstring of Artist.add_callback doesn't add much, and may
in fact make things more confusing for the reader ("oh, it's separately
documented here, perhaps it does something special?").
Also note that the docs for other Artist subclasses (e.g. Line2D,
AxesImage, etc.) don't bother repeating these either.
In particular, the property table for artists was changed to point links to the parent method which actually provides the docstring, if the docstring is inherited.
|
let's see if this fixes it... |
These methods directly pass through to the superclass and don't warrant
their own page (having a doc page for Tick.add_callback that just
reproes the docstring of Artist.add_callback doesn't add much, and may
in fact make things more confusing for the reader ("oh, it's separately
documented here, perhaps it does something special?").
Also note that the docs for other Artist subclasses (e.g. Line2D,
AxesImage, etc.) don't bother repeating these either.
attn @tacaswell who added these (together with the non-inherited methods, which should definitely be kept) in #7176.
This may also improve a bit the ci build, as this means ~20-25%(!) fewer API pages...
PR Summary
PR Checklist