Skip to content

Doc animation #7589

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 8 commits into from
Dec 12, 2016
Merged

Doc animation #7589

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
80d8dd8
DOC: partially numpydoc-ify animation module
tacaswell Dec 7, 2016
24c7aad
DOC: use auto summary in animation_api.rst
tacaswell Dec 8, 2016
e465fb7
DOC: start to add animation prose
tacaswell Dec 8, 2016
ff1e71e
DOC: address comments
tacaswell Dec 11, 2016
55017cd
DOC: re-work MovieWriter section a bit
tacaswell Dec 11, 2016
1a6c61c
DOC: address the rest of the comments
tacaswell Dec 11, 2016
8e8291c
DOC: Fix more typos and minor errors
tacaswell Dec 11, 2016
4c4779b
DOC: minor tweaks
tacaswell Dec 12, 2016
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
Prev Previous commit
Next Next commit
DOC: use auto summary in animation_api.rst
  • Loading branch information
@tacaswell
tacaswell committed Dec 8, 2016
commit 24c7aad75a21840bedcc6ee6a68ece2a35a2c758
119 changes: 110 additions & 9 deletions doc/api/animation_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,113 @@
*********
animation
*********
======================
``animation`` module
======================

.. currentmodule:: matplotlib.animation

:mod:`matplotlib.animation`
===========================

.. automodule:: matplotlib.animation
:members:
:undoc-members:
:show-inheritance:
Animation
=========

.. autosummary::
:toctree: _as_gen
:nosignatures:

FuncAnimation
ArtistAnimation
Animation.save


Writer Classes
==============



.. autosummary::
:toctree: _as_gen
:nosignatures:

AVConvFileWriter
AVConvWriter
FFMpegFileWriter
FFMpegWriter
ImageMagickFileWriter
ImageMagickWriter


Helper Classes
==============


Animation Base Classes
----------------------


.. autosummary::
:toctree: _as_gen
:nosignatures:

Animation
TimedAnimation


Writer Registry
---------------

A module-level registry is provided to map between the name of the
writer and the class to allow a string to be passed to
`Animation.save` instead of a writer instance.

.. autosummary::
:toctree: _as_gen
:nosignatures:

MovieWriterRegistry

Writer Base Classes
-------------------

To reduce code duplication base classes

.. autosummary::
:toctree: _as_gen
:nosignatures:

MovieWriter
FileMovieWriter

and mixins are provided

.. autosummary::
:toctree: _as_gen
:nosignatures:

AVConvBase
FFMpegBase
ImageMagickBase

See the source code for how to easily implement new `MovieWriter`
classes.


Inheritance Diagrams
====================

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

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



Deprecated
==========


.. autosummary::
:toctree: _as_gen
:nosignatures:

MencoderBase
MencoderFileWriter
MencoderWriter