SF.net SVN: matplotlib:[7203] trunk/matplotlib/doc/mpl_toolkits

[<he...@us...>]

Revision: 7203
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=7203&view=rev
Author:   heeres
Date:     2009-06-08 16:28:21 +0000 (Mon, 08 Jun 2009)

Log Message:
-----------
mplot3d: really add docs

Added Paths:
-----------
    trunk/matplotlib/doc/mpl_toolkits/mplot3d/
    trunk/matplotlib/doc/mpl_toolkits/mplot3d/api.rst
    trunk/matplotlib/doc/mpl_toolkits/mplot3d/index.rst
    trunk/matplotlib/doc/mpl_toolkits/mplot3d/tutorial.rst

Added: trunk/matplotlib/doc/mpl_toolkits/mplot3d/api.rst
===================================================================
--- trunk/matplotlib/doc/mpl_toolkits/mplot3d/api.rst	                        (rev 0)
+++ trunk/matplotlib/doc/mpl_toolkits/mplot3d/api.rst	2009-06-08 16:28:21 UTC (rev 7203)
@@ -0,0 +1,25 @@
+***********
+mplot3d API
+***********
+
+:mod:`mpl_toolkits.mplot3d.axes3d`
+==================================
+
+.. automodule:: mpl_toolkits.mplot3d.axes3d
+    :members:
+    :exclude-members: contour3D, contourf3D, plot3D, scatter3D
+    :show-inheritance:
+
+:mod:`mpl_toolkits.mplot3d.art3d`
+=================================
+
+.. automodule:: mpl_toolkits.mplot3d.art3d
+    :members:
+    :show-inheritance:
+
+:mod:`mpl_toolkits.mplot3d.proj3d`
+==================================
+
+.. automodule:: mpl_toolkits.mplot3d.proj3d
+    :members:
+    :show-inheritance:

Added: trunk/matplotlib/doc/mpl_toolkits/mplot3d/index.rst
===================================================================
--- trunk/matplotlib/doc/mpl_toolkits/mplot3d/index.rst	                        (rev 0)
+++ trunk/matplotlib/doc/mpl_toolkits/mplot3d/index.rst	2009-06-08 16:28:21 UTC (rev 7203)
@@ -0,0 +1,23 @@
+.. _toolkit_mplot3d-index:
+.. currentmodule:: mpl_toolkits.mplot3d
+
+*******
+mplot3d
+*******
+
+Matplotlib mplot3d toolkit
+==========================
+The mplot3d toolkit adds simple 3d plotting capabilities to matplotlib by
+supplying an axis object that can create a 2d projection of a 3d scene.
+In the end it produces a list of 2d lines and patches that are drawn by the
+normal matplotlib code. Therefore the resulting graph will have the same look
+and feel as regular 2d plots.
+
+Interactive backends also provide the ability to rotate and zoom the 3d scene.
+
+.. toctree::
+    :maxdepth: 2
+
+    tutorial.rst
+    api.rst
+

Added: trunk/matplotlib/doc/mpl_toolkits/mplot3d/tutorial.rst
===================================================================
--- trunk/matplotlib/doc/mpl_toolkits/mplot3d/tutorial.rst	                        (rev 0)
+++ trunk/matplotlib/doc/mpl_toolkits/mplot3d/tutorial.rst	2009-06-08 16:28:21 UTC (rev 7203)
@@ -0,0 +1,75 @@
+.. _toolkit_mplot3d-tutorial:
+.. currentmodule:: mpl_toolkits.mplot3d
+
+****************
+mplot3d tutorial
+****************
+
+Getting started
+===============
+Create a new :class:`matplotlib.figure.Figure` and an
+:class:`~mpl_toolkits.mplot3d.Axes3D` object in it::
+
+  import pylab
+  fig = pylab.figure()
+  from mpl_toolkits.mplot3d import Axes3D
+  ax = Axes3D(fig)
+
+Line plots
+====================
+.. automethod:: Axes3D.plot
+
+.. plot:: mpl_examples/mplot3d/lines3d_demo.py
+
+Scatter plots
+=============
+.. automethod:: Axes3D.scatter
+
+.. plot:: mpl_examples/mplot3d/scatter3d_demo.py
+
+Wireframe plots
+===============
+.. automethod:: Axes3D.plot_wireframe
+
+.. plot:: mpl_examples/mplot3d/wire3d_demo.py
+
+Surface plots
+=============
+.. automethod:: Axes3D.plot_surface
+
+.. plot:: mpl_examples/mplot3d/surface3d_demo.py
+
+Contour plots
+=============
+.. automethod:: Axes3D.contour
+
+.. plot:: mpl_examples/mplot3d/contour3d_demo.py
+
+Filled contour plots
+====================
+.. automethod:: Axes3D.contourf
+
+.. plot:: mpl_examples/mplot3d/contourf3d_demo.py
+
+Polygon plots
+====================
+.. automethod:: add_collection3d
+
+.. plot:: mpl_examples/mplot3d/polys3d_demo.py
+
+Bar plots
+====================
+.. automethod:: Axes3D.bar
+
+.. plot:: mpl_examples/mplot3d/bars3d_demo.py
+
+2D plots in 3D
+====================
+.. plot:: mpl_examples/mplot3d/2dcollections3d_demo.py
+
+Text
+====================
+.. automethod:: Axes3D.text
+
+.. plot:: mpl_examples/mplot3d/text3d_demo.py
+


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.