Skip to content

Commit

Permalink
Snapshot what is generated by the old sphinx autogen_api mechanism.
Browse files Browse the repository at this point in the history
The files will now live as first-class citizens allowing more controlled
customization of some files.
Refs #9624
  • Loading branch information
martyngigg committed Jun 11, 2014
1 parent 3337a2c commit e122a2b
Show file tree
Hide file tree
Showing 268 changed files with 3,607 additions and 0 deletions.
15 changes: 15 additions & 0 deletions Code/Mantid/docs/source/api/python/index.rst
@@ -0,0 +1,15 @@
.. _pythonapi:

============
Python API
============

The following pages document the Python bindings to the Mantid C++ libraries.

Reference
---------
.. toctree::
:maxdepth: 1

mantid <mantid/index>
mantidplot <mantidplot/index>
15 changes: 15 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/Algorithm.rst
@@ -0,0 +1,15 @@
===========
Algorithm
===========

This a python binding to the C++ class Mantid::API::Algorithm.

*bases:* :py:obj:`mantid.api.IAlgorithm`

.. module:`mantid.api`
.. autoclass:: mantid.api.Algorithm
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,14 @@
======================
AlgorithmFactoryImpl
======================

This a python binding to the C++ class Mantid::API::AlgorithmFactoryImpl.


.. module:`mantid.api`
.. autoclass:: mantid.api.AlgorithmFactoryImpl
:members:
:undoc-members:
:inherited-members:

14 changes: 14 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/AlgorithmHistory.rst
@@ -0,0 +1,14 @@
==================
AlgorithmHistory
==================

This a python binding to the C++ class Mantid::API::AlgorithmHistory.


.. module:`mantid.api`
.. autoclass:: mantid.api.AlgorithmHistory
:members:
:undoc-members:
:inherited-members:

14 changes: 14 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/AlgorithmID.rst
@@ -0,0 +1,14 @@
=============
AlgorithmID
=============

This a python binding to the C++ class Mantid::API::AlgorithmID.


.. module:`mantid.api`
.. autoclass:: mantid.api.AlgorithmID
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,14 @@
======================
AlgorithmManagerImpl
======================

This a python binding to the C++ class Mantid::API::AlgorithmManagerImpl.


.. module:`mantid.api`
.. autoclass:: mantid.api.AlgorithmManagerImpl
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,15 @@
===================
AlgorithmProperty
===================

This a python binding to the C++ class Mantid::API::AlgorithmProperty.

*bases:* :py:obj:`mantid.api.AlgorithmPropertyWithValue`

.. module:`mantid.api`
.. autoclass:: mantid.api.AlgorithmProperty
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,15 @@
============================
AlgorithmPropertyWithValue
============================

This a python binding to the C++ class Mantid::API::AlgorithmPropertyWithValue.

*bases:* :py:obj:`mantid.kernel.Property`

.. module:`mantid.api`
.. autoclass:: mantid.api.AlgorithmPropertyWithValue
:members:
:undoc-members:
:inherited-members:

15 changes: 15 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/AlgorithmProxy.rst
@@ -0,0 +1,15 @@
================
AlgorithmProxy
================

This a python binding to the C++ class Mantid::API::AlgorithmProxy.

*bases:* :py:obj:`mantid.api.IAlgorithm`

.. module:`mantid.api`
.. autoclass:: mantid.api.AlgorithmProxy
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,14 @@
=========================
AnalysisDataServiceImpl
=========================

This a python binding to the C++ class Mantid::API::AnalysisDataServiceImpl.


.. module:`mantid.api`
.. autoclass:: mantid.api.AnalysisDataServiceImpl
:members:
:undoc-members:
:inherited-members:

15 changes: 15 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/BinEdgeAxis.rst
@@ -0,0 +1,15 @@
=============
BinEdgeAxis
=============

This a python binding to the C++ class Mantid::API::BinEdgeAxis.

*bases:* :py:obj:`mantid.api.NumericAxis`

.. module:`mantid.api`
.. autoclass:: mantid.api.BinEdgeAxis
:members:
:undoc-members:
:inherited-members:

14 changes: 14 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/BoxController.rst
@@ -0,0 +1,14 @@
===============
BoxController
===============

This a python binding to the C++ class Mantid::API::BoxController.


.. module:`mantid.api`
.. autoclass:: mantid.api.BoxController
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,15 @@
=====================
CommonBinsValidator
=====================

This a python binding to the C++ class Mantid::API::CommonBinsValidator.

*bases:* :py:obj:`mantid.api.MatrixWorkspaceValidator`

.. module:`mantid.api`
.. autoclass:: mantid.api.CommonBinsValidator
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,15 @@
========================
DataProcessorAlgorithm
========================

This a python binding to the C++ class Mantid::API::DataProcessorAlgorithm.

*bases:* :py:obj:`mantid.api.Algorithm`

.. module:`mantid.api`
.. autoclass:: mantid.api.DataProcessorAlgorithm
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,14 @@
============================
DeprecatedAlgorithmChecker
============================

This a python binding to the C++ class Mantid::API::DeprecatedAlgorithm.


.. module:`mantid.api`
.. autoclass:: mantid.api.DeprecatedAlgorithmChecker
:members:
:undoc-members:
:inherited-members:

14 changes: 14 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/EventType.rst
@@ -0,0 +1,14 @@
===========
EventType
===========

This a python binding to the C++ class Mantid::API::EventType.


.. module:`mantid.api`
.. autoclass:: mantid.api.EventType
:members:
:undoc-members:
:inherited-members:

14 changes: 14 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/ExperimentInfo.rst
@@ -0,0 +1,14 @@
================
ExperimentInfo
================

This a python binding to the C++ class Mantid::API::ExperimentInfo.


.. module:`mantid.api`
.. autoclass:: mantid.api.ExperimentInfo
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,15 @@
=========================
ExperimentInfoValidator
=========================

This a python binding to the C++ class Mantid::API::ExperimentInfoValidator.

*bases:* :py:obj:`mantid.kernel.IValidator`

.. module:`mantid.api`
.. autoclass:: mantid.api.ExperimentInfoValidator
:members:
:undoc-members:
:inherited-members:

14 changes: 14 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/FileAction.rst
@@ -0,0 +1,14 @@
============
FileAction
============

This a python binding to the C++ class Mantid::API::FileProperty.


.. module:`mantid.api`
.. autoclass:: mantid.api.FileAction
:members:
:undoc-members:
:inherited-members:

14 changes: 14 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/FileFinderImpl.rst
@@ -0,0 +1,14 @@
================
FileFinderImpl
================

This a python binding to the C++ class Mantid::API::FileFinderImpl.


.. module:`mantid.api`
.. autoclass:: mantid.api.FileFinderImpl
:members:
:undoc-members:
:inherited-members:

15 changes: 15 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/FileProperty.rst
@@ -0,0 +1,15 @@
==============
FileProperty
==============

This a python binding to the C++ class Mantid::API::FileProperty.

*bases:* :py:obj:`mantid.kernel.StringPropertyWithValue`

.. module:`mantid.api`
.. autoclass:: mantid.api.FileProperty
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,14 @@
======================
FrameworkManagerImpl
======================

This a python binding to the C++ class Mantid::API::FrameworkManagerImpl.


.. module:`mantid.api`
.. autoclass:: mantid.api.FrameworkManagerImpl
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,14 @@
=====================
FunctionFactoryImpl
=====================

This a python binding to the C++ class Mantid::API::FunctionFactoryImpl.


.. module:`mantid.api`
.. autoclass:: mantid.api.FunctionFactoryImpl
:members:
:undoc-members:
:inherited-members:

15 changes: 15 additions & 0 deletions Code/Mantid/docs/source/api/python/mantid/api/FunctionProperty.rst
@@ -0,0 +1,15 @@
==================
FunctionProperty
==================

This a python binding to the C++ class Mantid::API::FunctionProperty.

*bases:* :py:obj:`mantid.api.FunctionPropertyWithValue`

.. module:`mantid.api`
.. autoclass:: mantid.api.FunctionProperty
:members:
:undoc-members:
:inherited-members:

@@ -0,0 +1,15 @@
===========================
FunctionPropertyWithValue
===========================

This a python binding to the C++ class Mantid::API::FunctionPropertyWithValue.

*bases:* :py:obj:`mantid.kernel.Property`

.. module:`mantid.api`
.. autoclass:: mantid.api.FunctionPropertyWithValue
:members:
:undoc-members:
:inherited-members:

0 comments on commit e122a2b

Please sign in to comment.