Merge branch 'plot_directive' of github.com:mdboom/matplotlib into minor_doc_fixes

mdboom · mdboom · commit 692604446dc7 · 2011-04-04T08:05:31.000-04:00
Conflicts:
	lib/matplotlib/sphinxext/plot_directive.py
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,8 @@
+2011-04-01 The plot directive Sphinx extension now supports all of the
+           features in the Numpy fork of that extension.  These
+           include doctest formatting, an 'include-source' option, and
+           a number of new configuration options. - MGD
+
 2011-03-10 Update pytz version to 2011c, thanks to Simon Cross. - JKS
 
 2011-03-06 Add standalone tests.py test runner script. - JKS
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -206,19 +206,6 @@ Figures can be automatically generated from scripts and included in
 the docs.  It is not necessary to explicitly save the figure in the
 script, this will be done automatically at build time to ensure that
 the code that is included runs and produces the advertised figure.
-Several figures will be saved with the same basename as the filename
-when the documentation is generated (low and high res PNGs, a PDF).
-Matplotlib includes a Sphinx extension
-(:file:`sphinxext/plot_directive.py`) for generating the images from
-the python script and including either a png copy for html or a pdf
-for latex::
-
-   .. plot:: pyplots/pyplot_simple.py
-      :include-source:
-
-If the script produces multiple figures (through multiple calls to
-:func:`pyplot.figure`), each will be given a numbered file name and
-included.
 
 The path should be relative to the ``doc`` directory.  Any plots
 specific to the documentation should be added to the ``doc/pyplots``
@@ -231,8 +218,12 @@ directory.  e.g.::
 The ``:scale:`` directive rescales the image to some percentage of the
 original size, though we don't recommend using this in most cases
 since it is probably better to choose the correct figure size and dpi
-in mpl and let it handle the scaling. ``:include-source:`` will
-present the contents of the file, marked up as source code.
+in mpl and let it handle the scaling.
+
+Plot directive documentation
+''''''''''''''''''''''''''''
+
+.. automodule:: matplotlib.sphinxext.plot_directive
 
 Static figures
 --------------
diff --git a/doc/users/image_tutorial.rst b/doc/users/image_tutorial.rst
@@ -152,7 +152,7 @@ plot from the prompt.
         import matplotlib.pyplot as plt
         import matplotlib.image as mpimg
         import numpy as np
-        img = mpimg.imread('_static/stinkbug.png')
+        img = mpimg.imread('../_static/stinkbug.png')
         imgplot = plt.imshow(img)
 
 You can also plot any numpy array - just remember that the datatype
@@ -188,7 +188,7 @@ This is array slicing.  You can read more in the `Numpy tutorial <http://www.sci
     import matplotlib.pyplot as plt
     import matplotlib.image as mpimg
     import numpy as np
-    img = mpimg.imread('_static/stinkbug.png')
+    img = mpimg.imread('../_static/stinkbug.png')
     lum_img = img[:,:,0]
     plt.imshow(lum_img)
 
@@ -207,7 +207,7 @@ object:
         import matplotlib.pyplot as plt
         import matplotlib.image as mpimg
         import numpy as np
-        img = mpimg.imread('_static/stinkbug.png')
+        img = mpimg.imread('../_static/stinkbug.png')
         lum_img = img[:,:,0]
         imgplot = plt.imshow(lum_img)
         imgplot.set_cmap('hot')
@@ -221,7 +221,7 @@ object:
         import matplotlib.pyplot as plt
         import matplotlib.image as mpimg
         import numpy as np
-        img = mpimg.imread('_static/stinkbug.png')
+        img = mpimg.imread('../_static/stinkbug.png')
         lum_img = img[:,:,0]
         imgplot = plt.imshow(lum_img)
         imgplot.set_cmap('spectral')
@@ -245,7 +245,7 @@ do that by adding color bars.  It's as easy as one line:
             import matplotlib.pyplot as plt
             import matplotlib.image as mpimg
             import numpy as np
-            img = mpimg.imread('_static/stinkbug.png')
+            img = mpimg.imread('../_static/stinkbug.png')
             lum_img = img[:,:,0]
             imgplot = plt.imshow(lum_img)
             imgplot.set_cmap('spectral')
@@ -276,7 +276,7 @@ image data, we use the :func:`~matplotlib.pyplot.hist` function.
     import matplotlib.pyplot as plt
     import matplotlib.image as mpimg
     import numpy as np
-    img = mpimg.imread('_static/stinkbug.png')
+    img = mpimg.imread('../_static/stinkbug.png')
     lum_img = img[:,:,0]
     plt.hist(lum_img.flatten(), 256, range=(0.0,1.0), fc='black', ec='black')
 
@@ -300,7 +300,7 @@ object.
     import numpy as np
     fig = plt.figure()
     a=fig.add_subplot(1,2,1)
-    img = mpimg.imread('_static/stinkbug.png')
+    img = mpimg.imread('../_static/stinkbug.png')
     lum_img = img[:,:,0]
     imgplot = plt.imshow(lum_img)
     a.set_title('Before')
@@ -343,7 +343,7 @@ and the computer has to draw in pixels to fill that space.
     import matplotlib.image as mpimg
     import numpy as np
     import Image
-    img = Image.open('_static/stinkbug.png')  # opens the file using PIL - it's not an array yet
+    img = Image.open('../_static/stinkbug.png')  # opens the file using PIL - it's not an array yet
     rsize = img.resize((img.size[0]/10,img.size[1]/10))  # resize the image
     rsizeArr = np.asarray(rsize)
     lum_img = rsizeArr[:,:,0]
@@ -364,7 +364,7 @@ Let's try some others:
         import matplotlib.image as mpimg
         import numpy as np
         import Image
-        img = Image.open('_static/stinkbug.png')  # opens the file using PIL - it's not an array yet
+        img = Image.open('../_static/stinkbug.png')  # opens the file using PIL - it's not an array yet
         rsize = img.resize((img.size[0]/10,img.size[1]/10))  # resize the image
         rsizeArr = np.asarray(rsize)
         lum_img = rsizeArr[:,:,0]
@@ -381,7 +381,7 @@ Let's try some others:
         import matplotlib.image as mpimg
         import numpy as np
         import Image
-        img = Image.open('_static/stinkbug.png')  # opens the file using PIL - it's not an array yet
+        img = Image.open('../_static/stinkbug.png')  # opens the file using PIL - it's not an array yet
         rsize = img.resize((img.size[0]/10,img.size[1]/10))  # resize the image
         rsizeArr = np.asarray(rsize)
         lum_img = rsizeArr[:,:,0]
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
