Thanks to visit codestin.com
Credit goes to github.com

Skip to content

animation api documentation changes #11831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 9, 2018
Merged

animation api documentation changes #11831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions doc/_templates/autosummary_inher.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{{ fullname | escape | underline}}


.. currentmodule:: {{ module }}

.. auto{{ objtype }}:: {{ objname }}
:inherited-members:
:show-inheritance:

{% if objtype in ['class', 'method', 'function'] %}
{% if objname in ['AxesGrid', 'Scalable', 'HostAxes', 'FloatingAxes',
'ParasiteAxesAuxTrans', 'ParasiteAxes'] %}
.. Filter out the above aliases to other classes, as sphinx gallery
creates no example file for those (sphinx-gallery/sphinx-gallery#365)

{% else %}
.. include:: {{module}}.{{objname}}.examples

.. raw:: html

<div class="clearer"></div>

{% endif %}
{% endif %}
14 changes: 12 additions & 2 deletions doc/api/animation_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The easiest way to make a live animation in matplotlib is to use one of the

.. autosummary::
:toctree: _as_gen
:template: autosummary_inher.rst
:nosignatures:

FuncAnimation
Expand Down Expand Up @@ -163,6 +164,7 @@ all data in memory.

.. autosummary::
:toctree: _as_gen
:template: autosummary_inher.rst
:nosignatures:

PillowWriter
Expand All @@ -173,10 +175,11 @@ on all systems.

.. autosummary::
:toctree: _as_gen
:template: autosummary_inher.rst
:nosignatures:

FFMpegWriter
ImageMagickFileWriter
ImageMagickWriter
AVConvWriter

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

.. autosummary::
:toctree: _as_gen
:template: autosummary_inher.rst
:nosignatures:

FFMpegFileWriter
ImageMagickWriter
ImageMagickFileWriter
AVConvFileWriter

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

.. autosummary::
:toctree: _as_gen
:template: autosummary_inher.rst
:nosignatures:

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

.. autosummary::
:toctree: _as_gen
:template: autosummary_inher.rst
:nosignatures:

MovieWriterRegistry
Expand All @@ -262,6 +268,7 @@ To reduce code duplication base classes

.. autosummary::
:toctree: _as_gen
:template: autosummary_inher.rst
:nosignatures:

AbstractMovieWriter
Expand All @@ -272,6 +279,7 @@ and mixins

.. autosummary::
:toctree: _as_gen
:template: autosummary_inher.rst
:nosignatures:

AVConvBase
Expand All @@ -287,6 +295,8 @@ Inheritance Diagrams

.. inheritance-diagram:: matplotlib.animation.FuncAnimation matplotlib.animation.ArtistAnimation
:private-bases:
:parts: 1

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