Movatterモバイル変換

[0]ホーム
URL:

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

 Sign up
Appearance settings

Commitcff3da2

Browse files
authored
Merge pull request#11831 from fredrik-1/animation_api
DOC: animation api documentation changes
2 parentsf61358a +68fe66d commitcff3da2

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

‎doc/_templates/autosummary_inher.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{{ fullname | escape | underline}}
2+
3+
4+
..currentmodule::{{ module }}
5+
6+
.. auto{{ objtype }}:: {{ objname }}
7+
:inherited-members:
8+
:show-inheritance:
9+
10+
{% if objtype in ['class', 'method', 'function'] %}
11+
{% if objname in ['AxesGrid', 'Scalable', 'HostAxes', 'FloatingAxes',
12+
'ParasiteAxesAuxTrans', 'ParasiteAxes'] %}
13+
.. Filter out the above aliases to other classes, as sphinx gallery
14+
creates no example file for those (sphinx-gallery/sphinx-gallery#365)
15+
16+
{% else %}
17+
..include::{{module}}.{{objname}}.examples
18+
19+
..raw::html
20+
21+
<divclass="clearer"></div>
22+
23+
{% endif %}
24+
{% endif %}

‎doc/api/animation_api.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The easiest way to make a live animation in matplotlib is to use one of the
1919

2020
..autosummary::
2121
:toctree: _as_gen
22+
:template: autosummary_inher.rst
2223
:nosignatures:
2324

2425
FuncAnimation
@@ -163,6 +164,7 @@ all data in memory.
163164

164165
..autosummary::
165166
:toctree: _as_gen
167+
:template: autosummary_inher.rst
166168
:nosignatures:
167169

168170
PillowWriter
@@ -173,10 +175,11 @@ on all systems.
173175

174176
..autosummary::
175177
:toctree: _as_gen
178+
:template: autosummary_inher.rst
176179
:nosignatures:
177180

178181
FFMpegWriter
179-
ImageMagickFileWriter
182+
ImageMagickWriter
180183
AVConvWriter
181184

182185
The file-based writers save temporary files for each frame which are stitched
@@ -185,10 +188,11 @@ debug.
185188

186189
..autosummary::
187190
:toctree: _as_gen
191+
:template: autosummary_inher.rst
188192
:nosignatures:
189193

190194
FFMpegFileWriter
191-
ImageMagickWriter
195+
ImageMagickFileWriter
192196
AVConvFileWriter
193197

194198
Fundamentally, a `MovieWriter` provides a way to grab sequential frames
@@ -237,6 +241,7 @@ Animation Base Classes
237241

238242
..autosummary::
239243
:toctree: _as_gen
244+
:template: autosummary_inher.rst
240245
:nosignatures:
241246

242247
Animation
@@ -251,6 +256,7 @@ writer and the class to allow a string to be passed to
251256

252257
..autosummary::
253258
:toctree: _as_gen
259+
:template: autosummary_inher.rst
254260
:nosignatures:
255261

256262
MovieWriterRegistry
@@ -262,6 +268,7 @@ To reduce code duplication base classes
262268

263269
..autosummary::
264270
:toctree: _as_gen
271+
:template: autosummary_inher.rst
265272
:nosignatures:
266273

267274
AbstractMovieWriter
@@ -272,6 +279,7 @@ and mixins
272279

273280
..autosummary::
274281
:toctree: _as_gen
282+
:template: autosummary_inher.rst
275283
:nosignatures:
276284

277285
AVConvBase
@@ -287,6 +295,8 @@ Inheritance Diagrams
287295

288296
..inheritance-diagram::matplotlib.animation.FuncAnimation matplotlib.animation.ArtistAnimation
289297
:private-bases:
298+
:parts: 1
290299

291300
..inheritance-diagram::matplotlib.animation.AVConvFileWriter matplotlib.animation.AVConvWriter matplotlib.animation.FFMpegFileWriter matplotlib.animation.FFMpegWriter matplotlib.animation.ImageMagickFileWriter matplotlib.animation.ImageMagickWriter
292301
:private-bases:
302+
:parts: 1

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp