Some more expansion and cleanup of mplot3d docs and examples

WeatherGod · WeatherGod · commit f672b59751ef · 2011-07-10T16:45:25.000-05:00
Also slightly tweaked the tick label and axis label spacing for improved visualization
diff --git a/doc/_static/demo_mplot3d.png b/doc/_static/demo_mplot3d.png
diff --git a/doc/mpl_toolkits/mplot3d/api.rst b/doc/mpl_toolkits/mplot3d/api.rst
@@ -3,9 +3,13 @@
 ***********
 mplot3d API
 ***********
+.. contents::
+      :backlinks: none
 
-:mod:`mpl_toolkits.mplot3d.axes3d`
-==================================
+.. _toolkit_mplot3d-axesapi:
+
+:mod:`~mpl_toolkits.mplot3d.axes3d`
+===================================
 
 .. note::
    Significant effort went into bringing axes3d to feature-parity with
@@ -17,8 +21,11 @@ mplot3d API
     :members:
     :show-inheritance:
 
-:mod:`mpl_toolkits.mplot3d.axis3d`
-==================================
+
+.. _toolkit_mplot3d-axisapi:
+
+:mod:`~mpl_toolkits.mplot3d.axis3d`
+===================================
 
 .. note::
    Historically, axis3d has suffered from having hard-coded constants
@@ -33,16 +40,21 @@ mplot3d API
     :members:
     :show-inheritance:
 
-:mod:`mpl_toolkits.mplot3d.art3d`
-=================================
+.. _toolkit_mplot3d-artapi:
+
+:mod:`~mpl_toolkits.mplot3d.art3d`
+==================================
 
 .. automodule:: mpl_toolkits.mplot3d.art3d
     :members:
     :show-inheritance:
 
-:mod:`mpl_toolkits.mplot3d.proj3d`
-==================================
+.. _toolkit_mplot3d-projapi:
+
+:mod:`~mpl_toolkits.mplot3d.proj3d`
+===================================
 
 .. automodule:: mpl_toolkits.mplot3d.proj3d
     :members:
     :show-inheritance:
+
diff --git a/doc/mpl_toolkits/mplot3d/faq.rst b/doc/mpl_toolkits/mplot3d/faq.rst
@@ -46,6 +46,7 @@ I don't like how the 3D plot is laid out, how do I change that?
 Historically, mplot3d has suffered from a hard-coding of parameters used
 to control visuals such as label spacing, tick length, and grid line width.
 Work is being done to eliminate this issue. For matplotlib v1.1.0, there is
-a semi-official manner to modify these parameters. See the note for axis3d
-in :doc:`_toolkit_mplot3d-api` for more information.
+a semi-official manner to modify these parameters. See the note in the
+:ref:`toolkit_mplot3d-axisapi` section of the mplot3d API documentation for
+more information.
 
diff --git a/doc/mpl_toolkits/mplot3d/index.rst b/doc/mpl_toolkits/mplot3d/index.rst
@@ -11,6 +11,8 @@ The mplot3d toolkit adds simple 3D plotting capabilities to matplotlib by
 supplying an axes object that can create a 2D projection of a 3D scene.
 The resulting graph will have the same look and feel as regular 2D plots.
 
+.. image:: ../../_static/demo_mplot3d.png
+
 The interactive backends also provide the ability to rotate and zoom
 the 3D scene. One can rotate the 3D scene by simply clicking-and-dragging
 the scene. Zooming is done by right-clicking the scene and dragging the
diff --git a/examples/mplot3d/surface3d_demo.py b/examples/mplot3d/surface3d_demo.py
@@ -1,6 +1,6 @@
 from mpl_toolkits.mplot3d import Axes3D
 from matplotlib import cm
-from matplotlib.ticker import LinearLocator, FixedLocator, FormatStrFormatter
+from matplotlib.ticker import LinearLocator, FormatStrFormatter
 import matplotlib.pyplot as plt
 import numpy as np
 
@@ -13,10 +13,10 @@
 Z = np.sin(R)
 surf = ax.plot_surface(X, Y, Z, rstride=1, cstride=1, cmap=cm.jet,
         linewidth=0, antialiased=False)
-ax.set_zlim3d(-1.01, 1.01)
+ax.set_zlim(-1.01, 1.01)
 
-ax.w_zaxis.set_major_locator(LinearLocator(10))
-ax.w_zaxis.set_major_formatter(FormatStrFormatter('%.03f'))
+ax.zaxis.set_major_locator(LinearLocator(10))
+ax.zaxis.set_major_formatter(FormatStrFormatter('%.02f'))
 
 fig.colorbar(surf, shrink=0.5, aspect=5)
 
diff --git a/examples/mplot3d/surface3d_demo3.py b/examples/mplot3d/surface3d_demo3.py
@@ -1,6 +1,6 @@
 from mpl_toolkits.mplot3d import Axes3D
 from matplotlib import cm
-from matplotlib.ticker import LinearLocator, FixedLocator, FormatStrFormatter
+from matplotlib.ticker import LinearLocator
 import matplotlib.pyplot as plt
 import numpy as np
 
@@ -25,7 +25,6 @@
 
 ax.set_zlim3d(-1, 1)
 ax.w_zaxis.set_major_locator(LinearLocator(6))
-ax.w_zaxis.set_major_formatter(FormatStrFormatter('%.03f'))
 
 plt.show()
 
diff --git a/lib/mpl_toolkits/mplot3d/axis3d.py b/lib/mpl_toolkits/mplot3d/axis3d.py
@@ -75,12 +75,12 @@ def __init__(self, adir, v_intervalx, d_intervalx, axes, *args, **kwargs):
         # This is a temporary member variable.
         # Do not depend on this existing in future releases!
         self._axinfo = self._AXINFO[adir].copy()
-        self._axinfo.update({'label' : {'space_factor': 1.3,
+        self._axinfo.update({'label' : {'space_factor': 1.6,
                                         'va': 'center',
                                         'ha': 'center'},
                              'tick' : {'inward_factor': 0.2,
                                        'outward_factor': 0.1},
-                             'ticklabel': {'space_factor': 0.6},
+                             'ticklabel': {'space_factor': 0.7},
                              'axisline': {'linewidth': 0.75,
                                           'color': (0, 0, 0, 1)},
                              'grid' : {'color': (0.9, 0.9, 0.9, 1),
