From e6faa43225408ed919a963ef5266b5a0090ab25e Mon Sep 17 00:00:00 2001 From: Federico Montesino Pouzols Date: Thu, 11 Dec 2014 12:52:54 +0000 Subject: [PATCH] Add future.pyplot sphinx html docs, re #10761 --- Code/Mantid/docs/source/api/python/index.rst | 9 +++++++++ .../api/python/mantidplot/future/pyplot/index.rst | 15 +++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 Code/Mantid/docs/source/api/python/mantidplot/future/pyplot/index.rst diff --git a/Code/Mantid/docs/source/api/python/index.rst b/Code/Mantid/docs/source/api/python/index.rst index b034348ff984..ba45b9030ec5 100644 --- 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 `. + .. toctree:: :hidden: changes +Future plotting interface +------------------------- + +.. toctree:: + :maxdepth: 1 + + mantidplot.future.pyplot + 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 new file mode 100644 index 000000000000..a49c2a210d19 --- /dev/null +++ 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: