Merge pull request matplotlib#500 from jdh2358/docfixes_1.1.x

Docfixes 1.1.x

Author: jdh2358

doc/api/artist_api.rst

@@ -15,13 +15,6 @@ artists
    :undoc-members:
    :show-inheritance:
 
-:mod:`matplotlib.legend`
-=============================
-
-.. automodule:: matplotlib.legend
-   :members:
-   :undoc-members:
-   :show-inheritance:
 
 :mod:`matplotlib.lines`
 =============================

doc/devel/documenting_mpl.rst

@@ -251,6 +251,37 @@ insert the following special comment anywhere in the script::
 
   # -*- noplot -*-
 
+Animations
+----------
+
+We have a matplotlib google/gmail account with username ``mplgithub``
+which we used to setup the github account but can be used for other
+purposes, like hosting google docs or youtube videos.  You can embed a
+matplotlib animation in the docs by first saving the animation as a
+movie using :meth:`matplotlib.animation.Animation.save`, and then
+uploading to `matplotlib's youtube
+channel <http://www.youtube.com/user/matplotlib>`_ and inserting the
+embedding string youtube provides like::
+
+  .. raw:: html
+
+     <iframe width="420" height="315"
+       src="http://www.youtube.com/embed/32cjc6V0OZY"
+       frameborder="0" allowfullscreen>
+     </iframe>
+
+An example save command to generate a movie looks like this
+
+.. sourcecode:: python
+
+    ani = animation.FuncAnimation(fig, animate, np.arange(1, len(y)),
+        interval=25, blit=True, init_func=init)
+
+    ani.save('double_pendulum.mp4', fps=15)
+
+Contact John Hunter for the login password to upload youtube videos of
+google docs to the mplgithub account.
+
 .. _referring-to-mpl-docs:
 
 Referring to mpl documents

doc/faq/index.rst

@@ -18,3 +18,5 @@ The Matplotlib FAQ
    usage_faq.rst
    howto_faq.rst
    troubleshooting_faq.rst
+   environment_variables_faq.rst
+

doc/matplotlibrc

@@ -13,3 +13,4 @@ docstring.hardcopy : True  # set this when you want to generate hardcopy docstri
 
 #examples.download : False  # False to bypass downloading mechanism
 #examples.directory : /your/path/to/sample_data/   # directory to look in if download is false
+

doc/users/arraydata.rst

@@ -30,12 +30,17 @@ Kevin Davies has extended Yannick Copin's original Sankey example into a module
 Animation
 ---------
 
-Ryan May has written a backend-independent
-framework for creating animated figures. The :mod:`~matplotlib.animation`
-module is intended to replace the
-backend-specific examples formerly in the :ref:`examples-index`
-listings.  Examples using the new framework are in
-:ref:`animation-examples-index`.
+Ryan May has written a backend-independent framework for creating
+animated figures. The :mod:`~matplotlib.animation` module is intended
+to replace the backend-specific examples formerly in the
+:ref:`examples-index` listings.  Examples using the new framework are
+in :ref:`animation-examples-index`; see the entrancing :ref:`double
+pendulum <animation-double_pendulum_animated>` which uses
+:meth:`matplotlib.animation.Animation.save` to create the movie below.
+
+.. raw:: html
+
+    <iframe width="420" height="315" src="http://www.youtube.com/embed/32cjc6V0OZY" frameborder="0" allowfullscreen></iframe>
 
 This should be considered as a beta release of the framework;
 please try it and provide feedback.
@@ -133,10 +138,12 @@ as 2D plotting, Ben Root has made several improvements to the
 * Most 3D plotting functions now support empty inputs
 
 * Ticker offset display added:
+
 .. plot:: mpl_examples/mplot3d/offset_demo.py
 
 * :meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.contourf`
   gains *zdir* and *offset* kwargs. You can now do this:
+
 .. plot:: mpl_examples/mplot3d/contourf3d_demo2.py
 
 Numerix support removed