Further revisions to the mplot3d docs to include when certain features were added, a table of contents, and improved the aspect ration of the subplot figures.

WeatherGod · WeatherGod · commit 6a16eead3f29 · 2011-03-14T14:55:32.000-05:00
diff --git a/doc/mpl_toolkits/mplot3d/tutorial.rst b/doc/mpl_toolkits/mplot3d/tutorial.rst
@@ -4,6 +4,10 @@
 ****************
 mplot3d tutorial
 ****************
+.. contents::
+      :backlinks: none
+
+.. _mplot3d_getting_started:
 
 Getting started
 ===============
@@ -26,24 +30,32 @@ add a new axes to it of type :class:`~mpl_toolkits.mplot3d.Axes3D`::
    ``ax = fig.add_subplot(111, projection='3d')``
    to ``ax = Axes3D(fig)``.
 
+.. _plot3d:
+
 Line plots
 ====================
 .. automethod:: Axes3D.plot
 
 .. plot:: mpl_examples/mplot3d/lines3d_demo.py
 
+.. _scatter3d:
+
 Scatter plots
 =============
 .. automethod:: Axes3D.scatter
 
 .. plot:: mpl_examples/mplot3d/scatter3d_demo.py
 
+.. _wireframe:
+
 Wireframe plots
 ===============
 .. automethod:: Axes3D.plot_wireframe
 
 .. plot:: mpl_examples/mplot3d/wire3d_demo.py
 
+.. _surface:
+
 Surface plots
 =============
 .. automethod:: Axes3D.plot_surface
@@ -52,6 +64,8 @@ Surface plots
 .. plot:: mpl_examples/mplot3d/surface3d_demo2.py
 .. plot:: mpl_examples/mplot3d/surface3d_demo3.py
 
+.. _contour3d:
+
 Contour plots
 =============
 .. automethod:: Axes3D.contour
@@ -60,43 +74,60 @@ Contour plots
 .. plot:: mpl_examples/mplot3d/contour3d_demo2.py
 .. plot:: mpl_examples/mplot3d/contour3d_demo3.py
 
+.. _contourf3d:
+
 Filled contour plots
 ====================
 .. automethod:: Axes3D.contourf
 
 .. plot:: mpl_examples/mplot3d/contourf3d_demo.py
 .. plot:: mpl_examples/mplot3d/contourf3d_demo2.py
 
+.. versionadded:: 1.0.1
+   The feature demoed in the second contourf3d example was enabled as a
+   result of a bugfix for version 1.0.1.
+
+.. _polygon3d:
+
 Polygon plots
 ====================
 .. automethod:: Axes3D.add_collection3d
 
 .. plot:: mpl_examples/mplot3d/polys3d_demo.py
 
+.. _bar3d:
+
 Bar plots
 ====================
 .. automethod:: Axes3D.bar
 
 .. plot:: mpl_examples/mplot3d/bars3d_demo.py
 
+.. _2dcollections3d:
+
 2D plots in 3D
 ====================
 .. plot:: mpl_examples/mplot3d/2dcollections3d_demo.py
 
+.. _text3d:
+
 Text
 ====================
 .. automethod:: Axes3D.text
 
 .. plot:: mpl_examples/mplot3d/text3d_demo.py
 
+.. _3dsubplots:
+
 Subplotting
 ====================
 Having multiple 3d plots in a single figure is the same
-as it is for 2d plots. And you can mix 2d and 3d plots
-into the same figure.
+as it is for 2d plots. Also, you can have both 2d and 3d plots
+in the same figure.
 
 .. versionadded:: 1.0.0
-   This feature was added in v1.0.0.  Earlier version can not do this.
+   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
diff --git a/examples/mplot3d/mixed_subplots_demo.py b/examples/mplot3d/mixed_subplots_demo.py
@@ -18,7 +18,8 @@ def f(t):
 t2 = np.arange(0.0, 5.0, 0.02)
 t3 = np.arange(0.0, 2.0, 0.01)
 
-fig = plt.figure()
+# Twice as tall as it is wide.
+fig = plt.figure(figsize=plt.figaspect(2.))
 fig.suptitle('A tale of 2 subplots')
 ax = fig.add_subplot(2, 1, 1)
 l = ax.plot(t1, f(t1), 'bo', 
diff --git a/examples/mplot3d/subplot3d_demo.py b/examples/mplot3d/subplot3d_demo.py
@@ -7,8 +7,8 @@
 from matplotlib import cm
 from mpl_toolkits.mplot3d.axes3d import get_test_data
 
-
-fig = plt.figure(figsize=(9.5,5.0))
+# Twice as wide as it is tall.
+fig = plt.figure(figsize=plt.figaspect(0.5))
 
 #---- First subplot
 ax = fig.add_subplot(1, 2, 1, projection='3d')
