Add an autogenerated plotting command summary.

matplotlib · mdboom · Aug 19, 2012 · Aug 3, 2012 · Aug 3, 2012 · Aug 3, 2012
commit 87f8df3bc020b91eb86b6c456a82c47ddac3b070
diff --git a/boilerplate.py b/boilerplate.py
@@ -20,7 +20,7 @@
 _fmtplot = """\
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
-@autogen_docstring(Axes.%(func)s)
+@_autogen_docstring(Axes.%(func)s)
 def %(func)s(%(argspec)s):
     %(ax)s = gca()
     # allow callers to override the hold state by passing hold=True|False
@@ -246,3 +246,12 @@ def %(name)s():
 for name in cmaps:
     print _fmtcmap%locals()
 
+print "# This function was autogenerated by boilerplate.py"
+print "def _colormaps():"
+print "    return ["
+for name in cmaps:
+    print "        %r," % name
+print "    ]"
+
+print
+print "_setup_pyplot_info_docstrings()"
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
@@ -62,7 +62,7 @@ <h1>Introduction</h1>
   For a sampling, see the <a href="{{ pathto('users/screenshots') }}">screenshots</a>, <a href="{{ pathto('gallery') }}">thumbnail</a> gallery,  and
     <a href="examples/index.html">examples</a> directory</p>
 
-  <p>For example, using "ipython -pylab" to provide an interactive
+  <p>For example, using <tt>"ipython --pylab"</tt> to provide an interactive
   environment, to generate 10,000 gaussian random numbers and plot a
   histogram with 100 bins, you simply need to
   type</p>
@@ -91,7 +91,7 @@ <h1>Documentation</h1>
 
   <p>Trying to learn how to do a particular kind of plot?  Check out
   the <a href="gallery.html">gallery</a>, <a href="examples/index.html">examples</a>,
-  or the <a href="api/pyplot_api.html">list of plotting
+  or the <a href="api/pyplot_summary.html">list of plotting
   commands</a>.</p>
 
   <h4>Other learning resources</h4>

diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -12,6 +12,7 @@
 .. toctree::
    :maxdepth: 1
 
+   pyplot_summary.rst
    api_changes.rst
    matplotlib_configuration_api.rst
    afm_api.rst

diff --git a/doc/api/pyplot_api.rst b/doc/api/pyplot_api.rst
@@ -1,7 +1,7 @@
 ******
 pyplot
 ******
- 
+
 
 :mod:`matplotlib.pyplot`
 ========================
@@ -10,3 +10,4 @@ pyplot
    :members:
    :undoc-members:
    :show-inheritance:
+   :exclude-members: plotting colormaps
diff --git a/doc/api/pyplot_summary.rst b/doc/api/pyplot_summary.rst
@@ -0,0 +1,8 @@
+Plotting commands summary
+=========================
+
+.. currentmodule:: matplotlib.pyplot
+
+.. autofunction:: plotting
+
+.. autofunction:: colormaps
diff --git a/doc/conf.py b/doc/conf.py
@@ -74,6 +74,8 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+default_role = 'obj'
+
 # Plot directive configuration
 # ----------------------------
 

diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -871,7 +871,7 @@ def rc(group, **kwargs):
 
 def rcdefaults():
     """
-    Restore the default rc params - these are not the params loaded by
+    Restore the default rc params.  These are not the params loaded by
     the rc file, but mpl's internal params.  See rc_file_defaults for
     reloading the default params from the rc file
     """

diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -730,6 +730,8 @@ def set(self, **kwargs):
 
     def findobj(self, match=None, include_self=True):
         """
+        Find artist objects.
+
         pyplot signature:
           findobj(o=gcf(), match=None, include_self=True)
 
@@ -1135,6 +1137,8 @@ def getp(obj, property=None):
 
 def setp(obj, *args, **kwargs):
     """
+    Set a property on an artist object.
+
     matplotlib supports the use of :func:`setp` ("set property") and
     :func:`getp` to set and get object properties, as well as to do
     introspection on the object.  For example, to set the linestyle of a