Add future.pyplot sphinx html docs, re #10761

mantidproject · Dec 11, 2014 · e6faa43 · e6faa43
1 parent 832fe21
commit e6faa43
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/Code/Mantid/docs/source/api/python/index.rst b/Code/Mantid/docs/source/api/python/index.rst
@@ -18,11 +18,20 @@ Reference
 
 Changes between version 1.0 and 2.0 of the API are described :ref:`here <pythonapi-changes>`.
 
+
 .. toctree::
    :hidden:
 
    changes
 
+Future plotting interface
+-------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   mantidplot.future.pyplot <mantidplot/future/pyplot/index>
+
 Techniques
 ----------
 

diff --git a/Code/Mantid/docs/source/api/python/mantidplot/future/pyplot/index.rst b/Code/Mantid/docs/source/api/python/mantidplot/future/pyplot/index.rst
@@ -0,0 +1,15 @@
+=================================================
+ :mod:`future.pyplot` --- Future plotting package
+=================================================
+
+New plotting interface
+----------------------
+
+This package provides a simple command line interface to the Mantid
+plotting functionality, resembling MatPlotLib and its pyplot package
+(http://matplotlib.org). The module is subject to changes and it is
+provided as a 'future' import. Feedback is very much welcome!
+
+.. automodule:: pymantidplot.future.pyplot
+   :members:
+   :show-inheritance: