Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 24c7aad

Browse filesBrowse files
committed
DOC: use auto summary in animation_api.rst
1 parent 80d8dd8 commit 24c7aad
Copy full SHA for 24c7aad

File tree

Expand file treeCollapse file tree

1 file changed

+110
-9
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+110
-9
lines changed

‎doc/api/animation_api.rst

Copy file name to clipboard
+110-9Lines changed: 110 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,113 @@
1-
*********
2-
animation
3-
*********
1+
======================
2+
``animation`` module
3+
======================
44

5+
.. currentmodule:: matplotlib.animation
56

6-
:mod:`matplotlib.animation`
7-
===========================
87

9-
.. automodule:: matplotlib.animation
10-
:members:
11-
:undoc-members:
12-
:show-inheritance:
8+
Animation
9+
=========
10+
11+
.. autosummary::
12+
:toctree: _as_gen
13+
:nosignatures:
14+
15+
FuncAnimation
16+
ArtistAnimation
17+
Animation.save
18+
19+
20+
Writer Classes
21+
==============
22+
23+
24+
25+
.. autosummary::
26+
:toctree: _as_gen
27+
:nosignatures:
28+
29+
AVConvFileWriter
30+
AVConvWriter
31+
FFMpegFileWriter
32+
FFMpegWriter
33+
ImageMagickFileWriter
34+
ImageMagickWriter
35+
36+
37+
Helper Classes
38+
==============
39+
40+
41+
Animation Base Classes
42+
----------------------
43+
44+
45+
.. autosummary::
46+
:toctree: _as_gen
47+
:nosignatures:
48+
49+
Animation
50+
TimedAnimation
51+
52+
53+
Writer Registry
54+
---------------
55+
56+
A module-level registry is provided to map between the name of the
57+
writer and the class to allow a string to be passed to
58+
`Animation.save` instead of a writer instance.
59+
60+
.. autosummary::
61+
:toctree: _as_gen
62+
:nosignatures:
63+
64+
MovieWriterRegistry
65+
66+
Writer Base Classes
67+
-------------------
68+
69+
To reduce code duplication base classes
70+
71+
.. autosummary::
72+
:toctree: _as_gen
73+
:nosignatures:
74+
75+
MovieWriter
76+
FileMovieWriter
77+
78+
and mixins are provided
79+
80+
.. autosummary::
81+
:toctree: _as_gen
82+
:nosignatures:
83+
84+
AVConvBase
85+
FFMpegBase
86+
ImageMagickBase
87+
88+
See the source code for how to easily implement new `MovieWriter`
89+
classes.
90+
91+
92+
Inheritance Diagrams
93+
====================
94+
95+
.. inheritance-diagram:: matplotlib.animation.FuncAnimation matplotlib.animation.ArtistAnimation
96+
:private-bases:
97+
98+
.. inheritance-diagram:: matplotlib.animation.AVConvFileWriter matplotlib.animation.AVConvWriter matplotlib.animation.FFMpegFileWriter matplotlib.animation.FFMpegWriter matplotlib.animation.ImageMagickFileWriter matplotlib.animation.ImageMagickWriter
99+
:private-bases:
100+
101+
102+
103+
Deprecated
104+
==========
105+
106+
107+
.. autosummary::
108+
:toctree: _as_gen
109+
:nosignatures:
110+
111+
MencoderBase
112+
MencoderFileWriter
113+
MencoderWriter

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.