Merge pull request matplotlib#1242 from pelson/doc_stuff

Doc tidy up.

Author: mdboom

doc/api/api_changes.rst

@@ -84,26 +84,28 @@ Changes in 1.2.x
   implements a non-affine transformation, then it should override the
   ``transform_non_affine`` method, rather than the generic ``transform`` method.
   Previously transforms would define ``transform`` and then copy the
-  method into ``transform_non_affine``:
+  method into ``transform_non_affine``::
 
      class MyTransform(mtrans.Transform):
          def transform(self, xy):
              ...
          transform_non_affine = transform
-
-  This approach will no longer function correctly and should be changed to:
+  
+  
+  This approach will no longer function correctly and should be changed to::
 
      class MyTransform(mtrans.Transform):
          def transform_non_affine(self, xy):
              ...
+  
 
 * Artists no longer have ``x_isdata`` or ``y_isdata`` attributes; instead
   any artist's transform can be interrogated with
   ``artist_instance.get_transform().contains_branch(ax.transData)``
 
 * Lines added to an axes now take into account their transform when updating the
   data and view limits. This means transforms can now be used as a pre-transform.
-  For instance:
+  For instance::
 
       >>> import matplotlib.pyplot as plt
       >>> import matplotlib.transforms as mtrans

doc/conf.py

@@ -25,6 +25,7 @@
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['matplotlib.sphinxext.mathmpl', 'math_symbol_table',
               'sphinx.ext.autodoc', 'matplotlib.sphinxext.only_directives',
+              'sphinx.ext.doctest',
               'matplotlib.sphinxext.plot_directive', 'sphinx.ext.inheritance_diagram',
               'gen_gallery', 'gen_rst',
               'matplotlib.sphinxext.ipython_console_highlighting', 'github']

doc/make.py

@@ -130,8 +130,11 @@ def sfpdf():
     'push a copy to the sf site'
     os.system('cd build/latex; scp Matplotlib.pdf jdh2358,[email protected]:/home/groups/m/ma/matplotlib/htdocs/')
 
-def figs():
-    os.system('cd users/figures/ && python make.py')
+def doctest():
+    os.system('sphinx-build -b doctest -d build/doctrees . build/doctest')
+
+def linkcheck():
+    os.system('sphinx-build -b linkcheck -d build/doctrees . build/linkcheck')
 
 def html():
     check_build()
@@ -215,14 +218,15 @@ def all():
 
 
 funcd = {
-    'figs'     : figs,
     'html'     : html,
     'latex'    : latex,
     'texinfo'  : texinfo,
     'clean'    : clean,
     'sf'       : sf,
     'sfpdf'    : sfpdf,
     'all'      : all,
+    'doctest'  : doctest,
+    'linkcheck': linkcheck,
     }
 
 

doc/mpl_toolkits/index.rst

@@ -1,5 +1,12 @@
 .. _toolkits-index:
 
+.. toctree::
+   :hidden:
+
+   axes_grid/index.rst
+   mplot3d/index.rst
+   
+
 ########
 Toolkits
 ########

doc/users/github_stats.rst

@@ -120,7 +120,7 @@ Pull Requests (123):
 * :ghpull:`1164`: doc: note contourf hatching in whats_new.rst
 * :ghpull:`1153`: PEP8 on artist
 * :ghpull:`1163`: tight_layout: fix regression for figures with non SubplotBase Axes
-* :ghpull:`1159`: FIX assert_raises cannot be called with ``with\\
+* :ghpull:`1159`: FIX assert_raises cannot be called with ``with``
 * :ghpull:`1160`: backend_pgf: clarifications and fixes in documentation
 * :ghpull:`1154`: six inclusion for dateutil on py3 doesn't work
 * :ghpull:`1149`: Add Phil Elson's percentage histogram example
@@ -268,7 +268,7 @@ Issues (226):
 * :ghissue:`1153`: PEP8 on artist
 * :ghissue:`1163`: tight_layout: fix regression for figures with non SubplotBase Axes
 * :ghissue:`1117`: ERROR: matplotlib.tests.test_axes.test_contour_colorbar.test fails on Python 3
-* :ghissue:`1159`: FIX assert_raises cannot be called with ``with\\
+* :ghissue:`1159`: FIX assert_raises cannot be called with ``with``
 * :ghissue:`206`: hist normed=True problem?
 * :ghissue:`1160`: backend_pgf: clarifications and fixes in documentation
 * :ghissue:`1154`: six inclusion for dateutil on py3 doesn't work

doc/users/index.rst

@@ -31,6 +31,7 @@ User's Guide
     recipes.rst
     screenshots.rst
     whats_new.rst
+    github_stats.rst
     license.rst
     credits.rst
 

examples/units/basic_units.py

@@ -17,14 +17,14 @@ def __get__(self, obj, objtype=None):
         return self.proxy_type(self.fn_name, obj)
 
 
-class TaggedValueMeta (type):
-    def __init__(cls, name, bases, dict):
-        for fn_name in cls._proxies.keys():
+class TaggedValueMeta(type):
+    def __init__(self, name, bases):
+        for fn_name in self._proxies.keys():
             try:
-                dummy = getattr(cls, fn_name)
+                dummy = getattr(self, fn_name)
             except AttributeError:
-                setattr(cls, fn_name,
-                        ProxyDelegate(fn_name, cls._proxies[fn_name]))
+                setattr(self, fn_name,
+                        ProxyDelegate(fn_name, self._proxies[fn_name]))
 
 
 class PassThroughProxy(object):
@@ -189,7 +189,7 @@ def get_unit(self):
         return self.unit
 
 
-TaggedValue = TaggedValueMeta('TaggedValue', (_TaggedValue, ), {})
+TaggedValue = TaggedValueMeta('TaggedValue', (_TaggedValue, ))
 
 
 class BasicUnit(object):

lib/matplotlib/axes.py

@@ -4433,44 +4433,44 @@ def legend(self, *args, **kwargs):
 
         Call signature::
 
-          legend(*args, **kwargs)
+           legend(*args, **kwargs)
 
         Places legend at location *loc*.  Labels are a sequence of
         strings and *loc* can be a string or an integer specifying the
         legend location.
 
         To make a legend with existing lines::
 
-          legend()
+           legend()
 
         :meth:`legend` by itself will try and build a legend using the label
         property of the lines/patches/collections.  You can set the label of
         a line by doing::
 
-          plot(x, y, label='my data')
+           plot(x, y, label='my data')
 
         or::
 
-          line.set_label('my data').
+           line.set_label('my data').
 
         If label is set to '_nolegend_', the item will not be shown in
         legend.
 
         To automatically generate the legend from labels::
 
-          legend( ('label1', 'label2', 'label3') )
+           legend( ('label1', 'label2', 'label3') )
 
         To make a legend for a list of lines and labels::
 
-          legend( (line1, line2, line3), ('label1', 'label2', 'label3') )
+           legend( (line1, line2, line3), ('label1', 'label2', 'label3') )
 
         To make a legend at a given location, using a location argument::
 
-          legend( ('label1', 'label2', 'label3'), loc='upper left')
+           legend( ('label1', 'label2', 'label3'), loc='upper left')
 
         or::
 
-          legend( (line1, line2, line3),  ('label1', 'label2', 'label3'), loc=2)
+           legend( (line1, line2, line3),  ('label1', 'label2', 'label3'), loc=2)
 
         The location codes are
 
@@ -4496,7 +4496,7 @@ def legend(self, *args, **kwargs):
         of BboxBase(or its derivatives) or a tuple of 2 or 4 floats.
         For example,
 
-          loc = 'upper right', bbox_to_anchor = (0.5, 0.5)
+           loc = 'upper right', bbox_to_anchor = (0.5, 0.5)
 
         will place the legend so that the upper right corner of the legend at
         the center of the axes.
@@ -7072,6 +7072,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
         **Example:**
 
         .. plot:: mpl_examples/pylab_examples/image_demo.py
+        
         """
 
         if not self._hold: self.cla()