Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 5 additions & 21 deletions doc/api/animation_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
======================

.. automodule:: matplotlib.animation
:no-members:
:no-undoc-members:

.. contents:: Table of Contents
:depth: 1
Expand Down Expand Up @@ -30,16 +32,10 @@ to. If you do not hold a reference to the `Animation` object, it (and
hence the timers), will be garbage collected which will stop the
animation.

To save an animation to disk use
To save an animation to disk use `Animation.save` or `Animation.to_html5_video`

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

Animation.save
Animation.to_html5_video

See :ref:`ani_writer_classes` below for details about what movie formats are supported.
See :ref:`ani_writer_classes` below for details about what movie formats are
supported.


``FuncAnimation``
Expand Down Expand Up @@ -206,18 +202,6 @@ class `MovieWriter` implements 3 methods and a context manager. The
only difference between the pipe-based and file-based writers is in the
arguments to their respective ``setup`` methods.


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

MovieWriter.setup
FileMovieWriter.setup
MovieWriter.grab_frame
MovieWriter.finish
MovieWriter.saving


The ``setup()`` method is used to prepare the writer (possibly opening
a pipe), successive calls to ``grab_frame()`` capture a single frame
at a time and ``finish()`` finalizes the movie and writes the output
Expand Down
4 changes: 4 additions & 0 deletions doc/api/artist_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,16 @@


.. automodule:: matplotlib.artist
:no-members:
:no-undoc-members:


``Artist`` class
================

.. autoclass:: Artist
:no-members:
:no-undoc-members:

Interactive
-----------
Expand Down
2 changes: 2 additions & 0 deletions doc/api/axes_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
.. currentmodule:: matplotlib.axes

.. autoclass:: Axes
:no-members:
:no-undoc-members:

.. contents:: Table of Contents
:depth: 2
Expand Down
16 changes: 16 additions & 0 deletions doc/api/axis_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
:backlinks: entry

.. automodule:: matplotlib.axis
:no-members:
:no-undoc-members:

Inheritance
===========
Expand All @@ -20,9 +22,17 @@ Inheritance
================

.. autoclass:: Axis
:no-members:
:no-undoc-members:
.. autoclass:: XAxis
:no-members:
:no-undoc-members:
.. autoclass:: YAxis
:no-members:
:no-undoc-members:
.. autoclass:: Ticker
:no-members:
:no-undoc-members:


.. autosummary::
Expand Down Expand Up @@ -235,8 +245,14 @@ not used together may de-couple your tick labels from your data.
================

.. autoclass:: Tick
:no-members:
:no-undoc-members:
.. autoclass:: XTick
:no-members:
:no-undoc-members:
.. autoclass:: YTick
:no-members:
:no-undoc-members:


.. autosummary::
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ def _check_deps():
autosummary_generate = True

autodoc_docstring_signature = True
autodoc_default_flags = ['members', 'undoc-members']

intersphinx_mapping = {
'python': ('https://docs.python.org/', None),
Expand Down
2 changes: 2 additions & 0 deletions lib/matplotlib/figure.py
Original file line number Diff line number Diff line change
Expand Up @@ -901,6 +901,8 @@ def add_axes(self, *args, **kwargs):

Examples
--------
A simple example::

rect = l,b,w,h
fig.add_axes(rect)
fig.add_axes(rect, frameon=False, facecolor='g')
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/sphinxext/plot_directive.py
Original file line number Diff line number Diff line change
Expand Up @@ -344,8 +344,8 @@ def split_code_at_show(text):


def remove_coding(text):
"""
Remove the coding comment, which six.exec_ doesn't like.
r"""
Remove the coding comment, which six.exec\_ doesn't like.
"""
sub_re = re.compile("^#\s*-\*-\s*coding:\s*.*-\*-$", flags=re.MULTILINE)
return sub_re.sub("", text)
Expand Down