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

Skip to content

Commit da25c48

Browse files
committed
Merge pull request #500 from jdh2358/docfixes_1.1.x
Docfixes 1.1.x
2 parents 674ee51 + d0ba36a commit da25c48

File tree

15 files changed

+171
-273
lines changed

15 files changed

+171
-273
lines changed

doc/api/artist_api.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,6 @@ artists
1515
:undoc-members:
1616
:show-inheritance:
1717

18-
:mod:`matplotlib.legend`
19-
=============================
20-
21-
.. automodule:: matplotlib.legend
22-
:members:
23-
:undoc-members:
24-
:show-inheritance:
2518

2619
:mod:`matplotlib.lines`
2720
=============================

doc/devel/documenting_mpl.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,37 @@ insert the following special comment anywhere in the script::
251251

252252
# -*- noplot -*-
253253

254+
Animations
255+
----------
256+
257+
We have a matplotlib google/gmail account with username ``mplgithub``
258+
which we used to setup the github account but can be used for other
259+
purposes, like hosting google docs or youtube videos. You can embed a
260+
matplotlib animation in the docs by first saving the animation as a
261+
movie using :meth:`matplotlib.animation.Animation.save`, and then
262+
uploading to `matplotlib's youtube
263+
channel <http://www.youtube.com/user/matplotlib>`_ and inserting the
264+
embedding string youtube provides like::
265+
266+
.. raw:: html
267+
268+
<iframe width="420" height="315"
269+
src="http://www.youtube.com/embed/32cjc6V0OZY"
270+
frameborder="0" allowfullscreen>
271+
</iframe>
272+
273+
An example save command to generate a movie looks like this
274+
275+
.. sourcecode:: python
276+
277+
ani = animation.FuncAnimation(fig, animate, np.arange(1, len(y)),
278+
interval=25, blit=True, init_func=init)
279+
280+
ani.save('double_pendulum.mp4', fps=15)
281+
282+
Contact John Hunter for the login password to upload youtube videos of
283+
google docs to the mplgithub account.
284+
254285
.. _referring-to-mpl-docs:
255286

256287
Referring to mpl documents

doc/faq/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ The Matplotlib FAQ
1818
usage_faq.rst
1919
howto_faq.rst
2020
troubleshooting_faq.rst
21+
environment_variables_faq.rst
22+

doc/matplotlibrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ docstring.hardcopy : True # set this when you want to generate hardcopy docstri
1313

1414
#examples.download : False # False to bypass downloading mechanism
1515
#examples.directory : /your/path/to/sample_data/ # directory to look in if download is false
16+

doc/users/arraydata.rst

Lines changed: 0 additions & 72 deletions
This file was deleted.

doc/users/plotting.rst

Lines changed: 0 additions & 155 deletions
This file was deleted.

doc/users/whats_new.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,17 @@ Kevin Davies has extended Yannick Copin's original Sankey example into a module
3030
Animation
3131
---------
3232

33-
Ryan May has written a backend-independent
34-
framework for creating animated figures. The :mod:`~matplotlib.animation`
35-
module is intended to replace the
36-
backend-specific examples formerly in the :ref:`examples-index`
37-
listings. Examples using the new framework are in
38-
:ref:`animation-examples-index`.
33+
Ryan May has written a backend-independent framework for creating
34+
animated figures. The :mod:`~matplotlib.animation` module is intended
35+
to replace the backend-specific examples formerly in the
36+
:ref:`examples-index` listings. Examples using the new framework are
37+
in :ref:`animation-examples-index`; see the entrancing :ref:`double
38+
pendulum <animation-double_pendulum_animated>` which uses
39+
:meth:`matplotlib.animation.Animation.save` to create the movie below.
40+
41+
.. raw:: html
42+
43+
<iframe width="420" height="315" src="http://www.youtube.com/embed/32cjc6V0OZY" frameborder="0" allowfullscreen></iframe>
3944

4045
This should be considered as a beta release of the framework;
4146
please try it and provide feedback.
@@ -133,10 +138,12 @@ as 2D plotting, Ben Root has made several improvements to the
133138
* Most 3D plotting functions now support empty inputs
134139

135140
* Ticker offset display added:
141+
136142
.. plot:: mpl_examples/mplot3d/offset_demo.py
137143

138144
* :meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.contourf`
139145
gains *zdir* and *offset* kwargs. You can now do this:
146+
140147
.. plot:: mpl_examples/mplot3d/contourf3d_demo2.py
141148

142149
Numerix support removed

0 commit comments

Comments
 (0)