8000 DOC: Move Animation and MovieWriter inheritance diagrams to their sec… · matplotlib/matplotlib@eb3eb03 · GitHub
[go: up one dir, main page]

Skip to content

Commit eb3eb03

Browse files
committed
DOC: Move Animation and MovieWriter inheritance diagrams to their sections
Inheritance diagrams belong next to the text that discuss the shown classes. Also: - remove `:private-bases:` option. - We don't have any private bases here so it did not have any effect. - exclude `ABC` as the top class for writers by specifying `:top-classes:`. It's irrelevant that we inherit from `ABC`. - add the missing `PillowWriter` and `HTMLWriter`
1 parent d5d1189 commit eb3eb03

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

doc/api/animation_api.rst

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,15 @@
1212
:backlinks: entry
1313

1414

15-
Inheritance Diagrams
16-
====================
17-
18-
.. inheritance-diagram:: matplotlib.animation.FuncAnimation matplotlib.animation.ArtistAnimation
19-
:private-bases:
20-
:parts: 1
21-
22-
.. inheritance-diagram:: matplotlib.animation.FFMpegFileWriter matplotlib.animation.FFMpegWriter matplotlib.animation.ImageMagickFileWriter matplotlib.animation.ImageMagickWriter
23-
:private-bases:
24-
:parts: 1
25-
2615
Animation
2716
=========
2817

2918
The easiest way to make a live animation in Matplotlib is to use one of the
3019
`Animation` classes.
3120

21+
.. inheritance-diagram:: matplotlib.animation.FuncAnimation matplotlib.animation.ArtistAnimation
22+
:parts: 1
23+
3224
.. autosummary::
3325
:toctree: _as_gen
3426
:nosignatures:
@@ -170,6 +162,10 @@ Examples
170162
Writer Classes
171163
==============
172164

165+
.. inheritance-diagram:: matplotlib.animation.FFMpegFileWriter matplotlib.animation.FFMpegWriter matplotlib.animation.ImageMagickFileWriter matplotlib.animation.ImageMagickWriter matplotlib.animation.PillowWriter matplotlib.animation.HTMLWriter
166+
:top-classes: matplotlib.animation.AbstractMovieWriter
167+
:parts: 1
168+
173169
The provided writers fall into a few broad categories.
174170

175171
The Pillow writer relies on the Pillow library to write the animation, keeping

0 commit comments

Comments
 (0)
0