DOC mplot3d is fully SG-compatible

matplotlib · NelleV · Mar 8, 2017 · Mar 9, 2017 · Mar 11, 2017 · Mar 11, 2017
commit 8bc4597d73c909753bd95be891adffe8819dc507
diff --git a/doc/mpl_toolkits/index.rst b/doc/mpl_toolkits/index.rst
@@ -30,7 +30,7 @@ plotting (scatter, surf, line, mesh) tools.  Not the fastest or feature
 complete 3D library out there, but ships with Matplotlib and thus may be a
 lighter weight solution for some use cases.
 
-.. plot:: mpl_examples/mplot3d/contourf3d_demo2.py
+.. plot:: auto_examples/mplot3d/plot_contourf3d_2.py
 
 .. _toolkit_axes_grid1:
 

diff --git a/doc/mpl_toolkits/mplot3d/tutorial.rst b/doc/mpl_toolkits/mplot3d/tutorial.rst
@@ -36,41 +36,41 @@ Line plots
 ====================
 .. automethod:: Axes3D.plot
 
-.. plot:: mpl_examples/mplot3d/lines3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_lines3d.py
 
 .. _scatter3d:
 
 Scatter plots
 =============
 .. automethod:: Axes3D.scatter
 
-.. plot:: mpl_examples/mplot3d/scatter3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_scatter3d.py
 
 .. _wireframe:
 
 Wireframe plots
 ===============
 .. automethod:: Axes3D.plot_wireframe
 
-.. plot:: mpl_examples/mplot3d/wire3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_wire3d.py
 
 .. _surface:
 
 Surface plots
 =============
 .. automethod:: Axes3D.plot_surface
 
-.. plot:: mpl_examples/mplot3d/surface3d_demo.py
-.. plot:: mpl_examples/mplot3d/surface3d_demo2.py
-.. plot:: mpl_examples/mplot3d/surface3d_demo3.py
+.. plot:: auto_examples/mplot3d/plot_surface3d.py
+.. plot:: auto_examples/mplot3d/plot_surface3d_2.py
+.. plot:: auto_examples/mplot3d/plot_surface3d_3.py
 
 .. _trisurface:
 
 Tri-Surface plots
 =================
 .. automethod:: Axes3D.plot_trisurf
 
-.. plot:: mpl_examples/mplot3d/trisurf3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_trisurf3d.py
 
 
 .. _contour3d:
@@ -79,18 +79,18 @@ Contour plots
 =============
 .. automethod:: Axes3D.contour
 
-.. plot:: mpl_examples/mplot3d/contour3d_demo.py
-.. plot:: mpl_examples/mplot3d/contour3d_demo2.py
-.. plot:: mpl_examples/mplot3d/contour3d_demo3.py
+.. plot:: auto_examples/mplot3d/plot_contour3d.py
+.. plot:: auto_examples/mplot3d/plot_contour3d_2.py
+.. plot:: auto_examples/mplot3d/plot_contour3d_3.py
 
 .. _contourf3d:
 
 Filled contour plots
 ====================
 .. automethod:: Axes3D.contourf
 
-.. plot:: mpl_examples/mplot3d/contourf3d_demo.py
-.. plot:: mpl_examples/mplot3d/contourf3d_demo2.py
+.. plot:: auto_examples/mplot3d/plot_contourf3d.py
+.. plot:: auto_examples/mplot3d/plot_contourf3d_2.py
 
 .. versionadded:: 1.1.0
    The feature demoed in the second contourf3d example was enabled as a
@@ -102,37 +102,37 @@ Polygon plots
 ====================
 .. automethod:: Axes3D.add_collection3d
 
-.. plot:: mpl_examples/mplot3d/polys3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_polys3d.py
 
 .. _bar3d:
 
 Bar plots
 ====================
 .. automethod:: Axes3D.bar
 
-.. plot:: mpl_examples/mplot3d/bars3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_bars3d.py
 
 .. _quiver3d:
 
 Quiver
 ====================
 .. automethod:: Axes3D.quiver
 
-.. plot:: mpl_examples/mplot3d/quiver3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_quiver3d.py
 
 .. _2dcollections3d:
 
 2D plots in 3D
 ====================
-.. plot:: mpl_examples/mplot3d/2dcollections3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_2dcollections3d.py
 
 .. _text3d:
 
 Text
 ====================
 .. automethod:: Axes3D.text
 
-.. plot:: mpl_examples/mplot3d/text3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_text3d.py
 
 .. _3dsubplots:
 
@@ -146,5 +146,5 @@ in the same figure.
    Subplotting 3D plots was added in v1.0.0.  Earlier version can not
    do this.
 
-.. plot:: mpl_examples/mplot3d/subplot3d_demo.py
-.. plot:: mpl_examples/mplot3d/mixed_subplots_demo.py
+.. plot:: auto_examples/mplot3d/plot_subplot3d.py
+.. plot:: auto_examples/mplot3d/plot_mixed_subplots.py
diff --git a/doc/users/prev_whats_new/whats_new_1.1.rst b/doc/users/prev_whats_new/whats_new_1.1.rst
@@ -135,12 +135,12 @@ as 2D plotting, Ben Root has made several improvements to the
 
 * Ticker offset display added:
 
-.. plot:: mpl_examples/mplot3d/offset_demo.py
+.. plot:: auto_examples/mplot3d/plot_offset.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
+.. plot:: auto_examples/mplot3d/plot_contourf3d_2.py
 
 Numerix support removed
 -----------------------

diff --git a/doc/users/prev_whats_new/whats_new_1.2.rst b/doc/users/prev_whats_new/whats_new_1.2.rst
@@ -61,7 +61,7 @@ Damon McDougall added a new plotting method for the
 :mod:`~mpl_toolkits.mplot3d` toolkit called
 :meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf`.
 
-.. plot:: mpl_examples/mplot3d/trisurf3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_trisurf3d.py
 
 Control the lengths of colorbar extensions
 ------------------------------------------

diff --git a/doc/users/prev_whats_new/whats_new_1.3.rst b/doc/users/prev_whats_new/whats_new_1.3.rst
@@ -100,7 +100,7 @@ Damon McDougall updated the
 :meth:`~mpl_toolkits.mplot3d.axes3d.Axes3D.tricontourf` methods to allow 3D
 contour plots on abitrary unstructured user-specified triangulations.
 
-.. plot:: mpl_examples/mplot3d/tricontour3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_tricontour3d.py
 
 New eventplot plot type
 ```````````````````````

diff --git a/doc/users/prev_whats_new/whats_new_1.4.rst b/doc/users/prev_whats_new/whats_new_1.4.rst
@@ -243,7 +243,7 @@ term project. This feature is documented in :func:`~mpl_toolkits.mplot3d.Axes3D.
 The team members are: Ryan Steve D'Souza, Victor B, xbtsw, Yang Wang, David,
 Caradec Bisesar and Vlad Vassilovski.
 
-.. plot:: mpl_examples/mplot3d/quiver3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_quiver3d.py
 
 polar-plot r-tick locations
 ```````````````````````````

diff --git a/doc/users/prev_whats_new/whats_new_1.5.rst b/doc/users/prev_whats_new/whats_new_1.5.rst
@@ -109,7 +109,7 @@ You can even multiply cyclers, which is like using `itertools.product()`
 on two or more property cycles. Remember to use parentheses if writing
 a multi-line `prop_cycle` parameter.
 
-.. plot:: mpl_examples/color/plot_color_cycle.py
+.. plot:: auto_examples/color/plot_color_cycle.py
 
 
 New Colormaps

diff --git a/doc/users/screenshots.rst b/doc/users/screenshots.rst
@@ -54,7 +54,7 @@ The mplot3d toolkit (see :ref:`toolkit_mplot3d-tutorial` and
 :ref:`mplot3d-examples-index`) has support for simple 3d graphs
 including surface, wireframe, scatter, and bar charts.
 
-.. plot:: mpl_examples/mplot3d/surface3d_demo.py
+.. plot:: auto_examples/mplot3d/plot_surface3d.py
 
 Thanks to John Porter, Jonathon Taylor, Reinier Heeres, and Ben Root for
 the `mplot3d` toolkit. This toolkit is included with all standard matplotlib

diff --git a/examples/mplot3d/README.txt b/examples/mplot3d/README.txt
@@ -0,0 +1,4 @@
+.. _mplot3d_example:
+
+mplot3d toolkit
+===============
diff --git a/examples/mplot3d/2dcollections3d_demo.py → examples/mplot3d/plot_2dcollections3d.py b/examples/mplot3d/2dcollections3d_demo.py → examples/mplot3d/plot_2dcollections3d.py
diff --git a/examples/mplot3d/bars3d_demo.py → examples/mplot3d/plot_bars3d.py b/examples/mplot3d/bars3d_demo.py → examples/mplot3d/plot_bars3d.py
diff --git a/examples/mplot3d/contour3d_demo.py → examples/mplot3d/plot_contour3d.py b/examples/mplot3d/contour3d_demo.py → examples/mplot3d/plot_contour3d.py
diff --git a/examples/mplot3d/contour3d_demo2.py → examples/mplot3d/plot_contour3d_2.py b/examples/mplot3d/contour3d_demo2.py → examples/mplot3d/plot_contour3d_2.py
diff --git a/examples/mplot3d/contour3d_demo3.py → examples/mplot3d/plot_contour3d_3.py b/examples/mplot3d/contour3d_demo3.py → examples/mplot3d/plot_contour3d_3.py
diff --git a/examples/mplot3d/contourf3d_demo.py → examples/mplot3d/plot_contourf3d.py b/examples/mplot3d/contourf3d_demo.py → examples/mplot3d/plot_contourf3d.py
diff --git a/examples/mplot3d/contourf3d_demo2.py → examples/mplot3d/plot_contourf3d_2.py b/examples/mplot3d/contourf3d_demo2.py → examples/mplot3d/plot_contourf3d_2.py
diff --git a/examples/mplot3d/custom_shaded_3d_surface.py → .../mplot3d/plot_custom_shaded_3d_surface.py b/examples/mplot3d/custom_shaded_3d_surface.py → .../mplot3d/plot_custom_shaded_3d_surface.py
diff --git a/examples/mplot3d/hist3d_demo.py → examples/mplot3d/plot_hist3d.py b/examples/mplot3d/hist3d_demo.py → examples/mplot3d/plot_hist3d.py
diff --git a/examples/mplot3d/lines3d_demo.py → examples/mplot3d/plot_lines3d.py b/examples/mplot3d/lines3d_demo.py → examples/mplot3d/plot_lines3d.py
diff --git a/examples/mplot3d/lorenz_attractor.py → examples/mplot3d/plot_lorenz_attractor.py b/examples/mplot3d/lorenz_attractor.py → examples/mplot3d/plot_lorenz_attractor.py
diff --git a/examples/mplot3d/mixed_subplots_demo.py → examples/mplot3d/plot_mixed_subplots.py b/examples/mplot3d/mixed_subplots_demo.py → examples/mplot3d/plot_mixed_subplots.py
diff --git a/examples/mplot3d/offset_demo.py → examples/mplot3d/plot_offset.py b/examples/mplot3d/offset_demo.py → examples/mplot3d/plot_offset.py
diff --git a/examples/mplot3d/pathpatch3d_demo.py → examples/mplot3d/plot_pathpatch3d.py b/examples/mplot3d/pathpatch3d_demo.py → examples/mplot3d/plot_pathpatch3d.py
diff --git a/examples/mplot3d/polys3d_demo.py → examples/mplot3d/plot_polys3d.py b/examples/mplot3d/polys3d_demo.py → examples/mplot3d/plot_polys3d.py
diff --git a/examples/mplot3d/quiver3d_demo.py → examples/mplot3d/plot_quiver3d.py b/examples/mplot3d/quiver3d_demo.py → examples/mplot3d/plot_quiver3d.py
diff --git a/examples/mplot3d/rotate_axes3d_demo.py → examples/mplot3d/plot_rotate_axes3d.py b/examples/mplot3d/rotate_axes3d_demo.py → examples/mplot3d/plot_rotate_axes3d.py
diff --git a/examples/mplot3d/scatter3d_demo.py → examples/mplot3d/plot_scatter3d.py b/examples/mplot3d/scatter3d_demo.py → examples/mplot3d/plot_scatter3d.py
diff --git a/examples/mplot3d/subplot3d_demo.py → examples/mplot3d/plot_subplot3d.py b/examples/mplot3d/subplot3d_demo.py → examples/mplot3d/plot_subplot3d.py
diff --git a/examples/mplot3d/surface3d_demo.py → examples/mplot3d/plot_surface3d.py b/examples/mplot3d/surface3d_demo.py → examples/mplot3d/plot_surface3d.py
diff --git a/examples/mplot3d/surface3d_demo2.py → examples/mplot3d/plot_surface3d_2.py b/examples/mplot3d/surface3d_demo2.py → examples/mplot3d/plot_surface3d_2.py
diff --git a/examples/mplot3d/surface3d_demo3.py → examples/mplot3d/plot_surface3d_3.py b/examples/mplot3d/surface3d_demo3.py → examples/mplot3d/plot_surface3d_3.py
diff --git a/examples/mplot3d/surface3d_radial_demo.py → examples/mplot3d/plot_surface3d_radial.py b/examples/mplot3d/surface3d_radial_demo.py → examples/mplot3d/plot_surface3d_radial.py
diff --git a/examples/mplot3d/text3d_demo.py → examples/mplot3d/plot_text3d.py b/examples/mplot3d/text3d_demo.py → examples/mplot3d/plot_text3d.py
@@ -6,10 +6,14 @@
 Demonstrates the placement of text annotations on a 3D plot.
 
 Functionality shown:
-- Using the text function with three types of 'zdir' values: None,
-  an axis name (ex. 'x'), or a direction tuple (ex. (1, 1, 0)).
-- Using the text function with the color keyword.
-- Using the text2D function to place text on a fixed position on the ax object.
+
+    - Using the text function with three types of 'zdir' values: None, an axis
+      name (ex. 'x'), or a direction tuple (ex. (1, 1, 0)).
+    - Using the text function with the color keyword.
+
+    - Using the text2D function to place text on a fixed position on the ax
+      object.
+
 '''
 
 from mpl_toolkits.mplot3d import Axes3D

diff --git a/examples/mplot3d/tricontour3d_demo.py → examples/mplot3d/plot_tricontour3d.py b/examples/mplot3d/tricontour3d_demo.py → examples/mplot3d/plot_tricontour3d.py
diff --git a/examples/mplot3d/tricontourf3d_demo.py → examples/mplot3d/plot_tricontourf3d.py b/examples/mplot3d/tricontourf3d_demo.py → examples/mplot3d/plot_tricontourf3d.py
diff --git a/examples/mplot3d/trisurf3d_demo.py → examples/mplot3d/plot_trisurf3d.py b/examples/mplot3d/trisurf3d_demo.py → examples/mplot3d/plot_trisurf3d.py
diff --git a/examples/mplot3d/trisurf3d_demo2.py → examples/mplot3d/plot_trisurf3d_2.py b/examples/mplot3d/trisurf3d_demo2.py → examples/mplot3d/plot_trisurf3d_2.py
diff --git a/examples/mplot3d/wire3d_demo.py → examples/mplot3d/plot_wire3d.py b/examples/mplot3d/wire3d_demo.py → examples/mplot3d/plot_wire3d.py
diff --git a/examples/mplot3d/wire3d_animation_demo.py → examples/mplot3d/plot_wire3d_animation.py b/examples/mplot3d/wire3d_animation_demo.py → examples/mplot3d/plot_wire3d_animation.py
diff --git a/examples/mplot3d/wire3d_zero_stride.py → examples/mplot3d/plot_wire3d_zero_stride.py b/examples/mplot3d/wire3d_zero_stride.py → examples/mplot3d/plot_wire3d_zero_stride.py
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -1911,8 +1911,8 @@ def plot_trisurf(self, *args, **kwargs):
 
         **Examples:**
 
-        .. plot:: mpl_examples/mplot3d/trisurf3d_demo.py
-        .. plot:: mpl_examples/mplot3d/trisurf3d_demo2.py
+        .. plot:: auto_examples/mplot3d/plot_trisurf3d.py
+        .. plot:: auto_examples/mplot3d/plot_trisurf3d_2.py
 
         .. versionadded:: 1.2.0
             This plotting function was added for the v1.2.0 release.