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 d241fd1

Browse filesBrowse files
authored
Merge pull request matplotlib#11835 from meeseeksmachine/auto-backport-of-pr-11831-on-v2.2.x
Backport PR matplotlib#11831 on branch v2.2.x
2 parents 0eb446f + 4fa7e14 commit d241fd1
Copy full SHA for d241fd1

File tree

Expand file treeCollapse file tree

2 files changed

+36
-2
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+36
-2
lines changed

‎doc/_templates/autosummary_inher.rst

Copy file name to clipboard
+24Lines 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+
<div class="clearer"></div>
22+
23+
{% endif %}
24+
{% endif %}

‎doc/api/animation_api.rst

Copy file name to clipboardExpand all lines: doc/api/animation_api.rst
+12-2Lines 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
@@ -160,6 +161,7 @@ all data in memory.
160161

161162
.. autosummary::
162163
:toctree: _as_gen
164+
:template: autosummary_inher.rst
163165
:nosignatures:
164166

165167
PillowWriter
@@ -170,10 +172,11 @@ on all systems.
170172

171173
.. autosummary::
172174
:toctree: _as_gen
175+
:template: autosummary_inher.rst
173176
:nosignatures:
174177

175178
FFMpegWriter
176-
ImageMagickFileWriter
179+
ImageMagickWriter
177180
AVConvWriter
178181

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

183186
.. autosummary::
184187
:toctree: _as_gen
188+
:template: autosummary_inher.rst
185189
:nosignatures:
186190

187191
FFMpegFileWriter
188-
ImageMagickWriter
192+
ImageMagickFileWriter
189193
AVConvFileWriter
190194

191195
Fundamentally, a `MovieWriter` provides a way to grab sequential frames
@@ -234,6 +238,7 @@ Animation Base Classes
234238

235239
.. autosummary::
236240
:toctree: _as_gen
241+
:template: autosummary_inher.rst
237242
:nosignatures:
238243

239244
Animation
@@ -248,6 +253,7 @@ writer and the class to allow a string to be passed to
248253

249254
.. autosummary::
250255
:toctree: _as_gen
256+
:template: autosummary_inher.rst
251257
:nosignatures:
252258

253259
MovieWriterRegistry
@@ -259,6 +265,7 @@ To reduce code duplication base classes
259265

260266
.. autosummary::
261267
:toctree: _as_gen
268+
:template: autosummary_inher.rst
262269
:nosignatures:
263270

264271
AbstractMovieWriter
@@ -269,6 +276,7 @@ and mixins
269276

270277
.. autosummary::
271278
:toctree: _as_gen
279+
:template: autosummary_inher.rst
272280
:nosignatures:
273281

274282
AVConvBase
@@ -284,6 +292,8 @@ Inheritance Diagrams
284292

285293
.. inheritance-diagram:: matplotlib.animation.FuncAnimation matplotlib.animation.ArtistAnimation
286294
:private-bases:
295+
:parts: 1
287296

288297
.. inheritance-diagram:: matplotlib.animation.AVConvFileWriter matplotlib.animation.AVConvWriter matplotlib.animation.FFMpegFileWriter matplotlib.animation.FFMpegWriter matplotlib.animation.ImageMagickFileWriter matplotlib.animation.ImageMagickWriter
289298
:private-bases:
299+
:parts: 1

0 commit comments

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