diff --git a/Code/Mantid/docs/source/api/python/index.rst b/Code/Mantid/docs/source/api/python/index.rst new file mode 100644 index 000000000000..05b62040b883 --- /dev/null +++ b/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 + mantidplot \ No newline at end of file diff --git a/Code/Mantid/docs/source/api/python/mantid/api/Algorithm.rst b/Code/Mantid/docs/source/api/python/mantid/api/Algorithm.rst new file mode 100644 index 000000000000..9be0850dc476 --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmFactoryImpl.rst b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmFactoryImpl.rst new file mode 100644 index 000000000000..b5e7b28a9123 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmFactoryImpl.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmHistory.rst b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmHistory.rst new file mode 100644 index 000000000000..7fda0bd412b5 --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmID.rst b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmID.rst new file mode 100644 index 000000000000..2b3475f41eca --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmManagerImpl.rst b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmManagerImpl.rst new file mode 100644 index 000000000000..551d121887ce --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmManagerImpl.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmProperty.rst new file mode 100644 index 000000000000..e1451bc800f3 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmProperty.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmPropertyWithValue.rst new file mode 100644 index 000000000000..27395c07fc07 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmPropertyWithValue.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmProxy.rst b/Code/Mantid/docs/source/api/python/mantid/api/AlgorithmProxy.rst new file mode 100644 index 000000000000..824754449dab --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/AnalysisDataServiceImpl.rst b/Code/Mantid/docs/source/api/python/mantid/api/AnalysisDataServiceImpl.rst new file mode 100644 index 000000000000..3c656a934f83 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/AnalysisDataServiceImpl.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/BinEdgeAxis.rst b/Code/Mantid/docs/source/api/python/mantid/api/BinEdgeAxis.rst new file mode 100644 index 000000000000..c5fa3ae2953c --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/BoxController.rst b/Code/Mantid/docs/source/api/python/mantid/api/BoxController.rst new file mode 100644 index 000000000000..7e42e71c2aa7 --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/CommonBinsValidator.rst b/Code/Mantid/docs/source/api/python/mantid/api/CommonBinsValidator.rst new file mode 100644 index 000000000000..31a55a0a885e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/CommonBinsValidator.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/DataProcessorAlgorithm.rst b/Code/Mantid/docs/source/api/python/mantid/api/DataProcessorAlgorithm.rst new file mode 100644 index 000000000000..7a70cea90bbd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/DataProcessorAlgorithm.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/DeprecatedAlgorithmChecker.rst b/Code/Mantid/docs/source/api/python/mantid/api/DeprecatedAlgorithmChecker.rst new file mode 100644 index 000000000000..da7db9459cd3 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/DeprecatedAlgorithmChecker.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/EventType.rst b/Code/Mantid/docs/source/api/python/mantid/api/EventType.rst new file mode 100644 index 000000000000..493680f818c2 --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/ExperimentInfo.rst b/Code/Mantid/docs/source/api/python/mantid/api/ExperimentInfo.rst new file mode 100644 index 000000000000..3ce6f20c07ad --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/ExperimentInfoValidator.rst b/Code/Mantid/docs/source/api/python/mantid/api/ExperimentInfoValidator.rst new file mode 100644 index 000000000000..1087657bea2e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/ExperimentInfoValidator.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/FileAction.rst b/Code/Mantid/docs/source/api/python/mantid/api/FileAction.rst new file mode 100644 index 000000000000..06fee1b03888 --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/FileFinderImpl.rst b/Code/Mantid/docs/source/api/python/mantid/api/FileFinderImpl.rst new file mode 100644 index 000000000000..99ba18411bd7 --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/FileProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/FileProperty.rst new file mode 100644 index 000000000000..84065e30bb75 --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/FrameworkManagerImpl.rst b/Code/Mantid/docs/source/api/python/mantid/api/FrameworkManagerImpl.rst new file mode 100644 index 000000000000..5b989eb951fd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/FrameworkManagerImpl.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/FunctionFactoryImpl.rst b/Code/Mantid/docs/source/api/python/mantid/api/FunctionFactoryImpl.rst new file mode 100644 index 000000000000..d279475509cd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/FunctionFactoryImpl.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/FunctionProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/FunctionProperty.rst new file mode 100644 index 000000000000..63e8783cb5a9 --- /dev/null +++ b/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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/FunctionPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/api/FunctionPropertyWithValue.rst new file mode 100644 index 000000000000..a7c99e634633 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/FunctionPropertyWithValue.rst @@ -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: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/HistogramValidator.rst b/Code/Mantid/docs/source/api/python/mantid/api/HistogramValidator.rst new file mode 100644 index 000000000000..f49ad2a6edae --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/HistogramValidator.rst @@ -0,0 +1,15 @@ +==================== + HistogramValidator +==================== + +This a python binding to the C++ class Mantid::API::HistogramValidator. + +*bases:* :py:obj:`mantid.api.MatrixWorkspaceValidator` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.HistogramValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IAlgorithm.rst b/Code/Mantid/docs/source/api/python/mantid/api/IAlgorithm.rst new file mode 100644 index 000000000000..2d2208a40799 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IAlgorithm.rst @@ -0,0 +1,15 @@ +============ + IAlgorithm +============ + +This a python binding to the C++ class Mantid::API::IAlgorithm. + +*bases:* :py:obj:`mantid.kernel.IPropertyManager` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IAlgorithm + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IEventList.rst b/Code/Mantid/docs/source/api/python/mantid/api/IEventList.rst new file mode 100644 index 000000000000..639749a577e7 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IEventList.rst @@ -0,0 +1,14 @@ +============ + IEventList +============ + +This a python binding to the C++ class Mantid::API::IEventList. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IEventList + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IEventWorkspace.rst b/Code/Mantid/docs/source/api/python/mantid/api/IEventWorkspace.rst new file mode 100644 index 000000000000..359981467b60 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IEventWorkspace.rst @@ -0,0 +1,15 @@ +================= + IEventWorkspace +================= + +This a python binding to the C++ class Mantid::API::IEventWorkspace. + +*bases:* :py:obj:`mantid.api.MatrixWorkspace` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IEventWorkspace + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IEventWorkspaceProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/IEventWorkspaceProperty.rst new file mode 100644 index 000000000000..069eac4b7372 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IEventWorkspaceProperty.rst @@ -0,0 +1,15 @@ +========================= + IEventWorkspaceProperty +========================= + +This a python binding to the C++ class Mantid::API::WorkspaceProperty. + +*bases:* :py:obj:`mantid.api.IEventWorkspacePropertyPropertyWithValue`, :py:obj:`mantid.api.IWorkspaceProperty` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IEventWorkspaceProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IEventWorkspacePropertyPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/api/IEventWorkspacePropertyPropertyWithValue.rst new file mode 100644 index 000000000000..324a7dd39db8 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IEventWorkspacePropertyPropertyWithValue.rst @@ -0,0 +1,15 @@ +========================================== + IEventWorkspacePropertyPropertyWithValue +========================================== + +This a python binding to the C++ class Mantid::API::IEventWorkspacePropertyPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IEventWorkspacePropertyPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IFunction.rst b/Code/Mantid/docs/source/api/python/mantid/api/IFunction.rst new file mode 100644 index 000000000000..57b91f662edf --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IFunction.rst @@ -0,0 +1,14 @@ +=========== + IFunction +=========== + +This a python binding to the C++ class Mantid::API::IFunction. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IFunction + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IFunction1D.rst b/Code/Mantid/docs/source/api/python/mantid/api/IFunction1D.rst new file mode 100644 index 000000000000..5d4665d84213 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IFunction1D.rst @@ -0,0 +1,15 @@ +============= + IFunction1D +============= + +This a python binding to the C++ class Mantid::API::IFunction1D. + +*bases:* :py:obj:`mantid.api.IFunction` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IFunction1D + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IMDEventWorkspace.rst b/Code/Mantid/docs/source/api/python/mantid/api/IMDEventWorkspace.rst new file mode 100644 index 000000000000..a1f23bac9ea8 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IMDEventWorkspace.rst @@ -0,0 +1,15 @@ +=================== + IMDEventWorkspace +=================== + +This a python binding to the C++ class Mantid::API::IMDEventWorkspace. + +*bases:* :py:obj:`mantid.api.IMDWorkspace`, :py:obj:`mantid.api.MultipleExperimentInfos` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IMDEventWorkspace + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IMDHistoWorkspace.rst b/Code/Mantid/docs/source/api/python/mantid/api/IMDHistoWorkspace.rst new file mode 100644 index 000000000000..b589834d3efc --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IMDHistoWorkspace.rst @@ -0,0 +1,15 @@ +=================== + IMDHistoWorkspace +=================== + +This a python binding to the C++ class Mantid::API::IMDHistoWorkspace. + +*bases:* :py:obj:`mantid.api.IMDWorkspace`, :py:obj:`mantid.api.MultipleExperimentInfos` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IMDHistoWorkspace + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IMDHistoWorkspaceProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/IMDHistoWorkspaceProperty.rst new file mode 100644 index 000000000000..af712d99eab1 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IMDHistoWorkspaceProperty.rst @@ -0,0 +1,15 @@ +=========================== + IMDHistoWorkspaceProperty +=========================== + +This a python binding to the C++ class Mantid::API::WorkspaceProperty. + +*bases:* :py:obj:`mantid.api.IMDHistoWorkspacePropertyPropertyWithValue`, :py:obj:`mantid.api.IWorkspaceProperty` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IMDHistoWorkspaceProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IMDHistoWorkspacePropertyPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/api/IMDHistoWorkspacePropertyPropertyWithValue.rst new file mode 100644 index 000000000000..286f12824739 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IMDHistoWorkspacePropertyPropertyWithValue.rst @@ -0,0 +1,15 @@ +============================================ + IMDHistoWorkspacePropertyPropertyWithValue +============================================ + +This a python binding to the C++ class Mantid::API::IMDHistoWorkspacePropertyPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IMDHistoWorkspacePropertyPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IMDWorkspace.rst b/Code/Mantid/docs/source/api/python/mantid/api/IMDWorkspace.rst new file mode 100644 index 000000000000..1653fba63ab6 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IMDWorkspace.rst @@ -0,0 +1,15 @@ +============== + IMDWorkspace +============== + +This a python binding to the C++ class Mantid::API::IMDWorkspace. + +*bases:* :py:obj:`mantid.api.Workspace`, :py:obj:`mantid.api.MDGeometry` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IMDWorkspace + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IPeak.rst b/Code/Mantid/docs/source/api/python/mantid/api/IPeak.rst new file mode 100644 index 000000000000..cce9eb07ff95 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IPeak.rst @@ -0,0 +1,14 @@ +======= + IPeak +======= + +This a python binding to the C++ class Mantid::API::IPeak. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IPeak + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IPeakFunction.rst b/Code/Mantid/docs/source/api/python/mantid/api/IPeakFunction.rst new file mode 100644 index 000000000000..86fc2f37384d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IPeakFunction.rst @@ -0,0 +1,15 @@ +=============== + IPeakFunction +=============== + +This a python binding to the C++ class Mantid::API::IPeakFunction. + +*bases:* :py:obj:`mantid.api.IFunction1D` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IPeakFunction + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IPeaksWorkspace.rst b/Code/Mantid/docs/source/api/python/mantid/api/IPeaksWorkspace.rst new file mode 100644 index 000000000000..e4c11234f0f4 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IPeaksWorkspace.rst @@ -0,0 +1,15 @@ +================= + IPeaksWorkspace +================= + +This a python binding to the C++ class Mantid::API::IPeaksWorkspace. + +*bases:* :py:obj:`mantid.api.ITableWorkspace`, :py:obj:`mantid.api.ExperimentInfo` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IPeaksWorkspace + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/ISpectrum.rst b/Code/Mantid/docs/source/api/python/mantid/api/ISpectrum.rst new file mode 100644 index 000000000000..21dd596ef30b --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/ISpectrum.rst @@ -0,0 +1,14 @@ +=========== + ISpectrum +=========== + +This a python binding to the C++ class Mantid::API::ISpectrum. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.ISpectrum + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/ITableWorkspace.rst b/Code/Mantid/docs/source/api/python/mantid/api/ITableWorkspace.rst new file mode 100644 index 000000000000..bca08c77dd19 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/ITableWorkspace.rst @@ -0,0 +1,15 @@ +================= + ITableWorkspace +================= + +This a python binding to the C++ class Mantid::API::ITableWorkspace. + +*bases:* :py:obj:`mantid.api.Workspace` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.ITableWorkspace + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/ITableWorkspaceProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/ITableWorkspaceProperty.rst new file mode 100644 index 000000000000..4748196ccd15 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/ITableWorkspaceProperty.rst @@ -0,0 +1,15 @@ +========================= + ITableWorkspaceProperty +========================= + +This a python binding to the C++ class Mantid::API::WorkspaceProperty. + +*bases:* :py:obj:`mantid.api.ITableWorkspacePropertyPropertyWithValue`, :py:obj:`mantid.api.IWorkspaceProperty` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.ITableWorkspaceProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/ITableWorkspacePropertyPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/api/ITableWorkspacePropertyPropertyWithValue.rst new file mode 100644 index 000000000000..e7e46c06228b --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/ITableWorkspacePropertyPropertyWithValue.rst @@ -0,0 +1,15 @@ +========================================== + ITableWorkspacePropertyPropertyWithValue +========================================== + +This a python binding to the C++ class Mantid::API::ITableWorkspacePropertyPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.ITableWorkspacePropertyPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/IWorkspaceProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/IWorkspaceProperty.rst new file mode 100644 index 000000000000..b34f7f9cce0f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/IWorkspaceProperty.rst @@ -0,0 +1,14 @@ +==================== + IWorkspaceProperty +==================== + +This a python binding to the C++ class Mantid::API::WorkspaceProperty. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.IWorkspaceProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/InstrumentValidator.rst b/Code/Mantid/docs/source/api/python/mantid/api/InstrumentValidator.rst new file mode 100644 index 000000000000..b4d5b21411d0 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/InstrumentValidator.rst @@ -0,0 +1,15 @@ +===================== + InstrumentValidator +===================== + +This a python binding to the C++ class Mantid::API::InstrumentValidator. + +*bases:* :py:obj:`mantid.api.ExperimentInfoValidator` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.InstrumentValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/Jacobian.rst b/Code/Mantid/docs/source/api/python/mantid/api/Jacobian.rst new file mode 100644 index 000000000000..67e0ec7f159a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/Jacobian.rst @@ -0,0 +1,14 @@ +========== + Jacobian +========== + +This a python binding to the C++ class Mantid::API::Jacobian. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.Jacobian + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/LockMode.rst b/Code/Mantid/docs/source/api/python/mantid/api/LockMode.rst new file mode 100644 index 000000000000..197b5af819a2 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/LockMode.rst @@ -0,0 +1,14 @@ +========== + LockMode +========== + +This a python binding to the C++ class Mantid::API::LockMode. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.LockMode + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/MDGeometry.rst b/Code/Mantid/docs/source/api/python/mantid/api/MDGeometry.rst new file mode 100644 index 000000000000..8238cd4dcad5 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/MDGeometry.rst @@ -0,0 +1,14 @@ +============ + MDGeometry +============ + +This a python binding to the C++ class Mantid::API::MDGeometry. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.MDGeometry + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/MDNormalization.rst b/Code/Mantid/docs/source/api/python/mantid/api/MDNormalization.rst new file mode 100644 index 000000000000..fc26778a3fb3 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/MDNormalization.rst @@ -0,0 +1,14 @@ +================= + MDNormalization +================= + +This a python binding to the C++ class Mantid::API::MDNormalization. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.MDNormalization + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/MantidAxis.rst b/Code/Mantid/docs/source/api/python/mantid/api/MantidAxis.rst new file mode 100644 index 000000000000..1adff1a30e9f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/MantidAxis.rst @@ -0,0 +1,14 @@ +============ + MantidAxis +============ + +This a python binding to the C++ class Mantid::API::MantidAxis. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.MantidAxis + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspace.rst b/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspace.rst new file mode 100644 index 000000000000..f7d69a1fc061 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspace.rst @@ -0,0 +1,15 @@ +================= + MatrixWorkspace +================= + +This a python binding to the C++ class Mantid::API::MatrixWorkspace. + +*bases:* :py:obj:`mantid.api.ExperimentInfo`, :py:obj:`mantid.api.IMDWorkspace` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.MatrixWorkspace + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspaceProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspaceProperty.rst new file mode 100644 index 000000000000..514dddd9462f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspaceProperty.rst @@ -0,0 +1,15 @@ +========================= + MatrixWorkspaceProperty +========================= + +This a python binding to the C++ class Mantid::API::WorkspaceProperty. + +*bases:* :py:obj:`mantid.api.MatrixWorkspacePropertyPropertyWithValue`, :py:obj:`mantid.api.IWorkspaceProperty` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.MatrixWorkspaceProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspacePropertyPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspacePropertyPropertyWithValue.rst new file mode 100644 index 000000000000..ab515f8bad18 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspacePropertyPropertyWithValue.rst @@ -0,0 +1,15 @@ +========================================== + MatrixWorkspacePropertyPropertyWithValue +========================================== + +This a python binding to the C++ class Mantid::API::MatrixWorkspacePropertyPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.MatrixWorkspacePropertyPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspaceValidator.rst b/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspaceValidator.rst new file mode 100644 index 000000000000..45239daeec9a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/MatrixWorkspaceValidator.rst @@ -0,0 +1,15 @@ +========================== + MatrixWorkspaceValidator +========================== + +This a python binding to the C++ class Mantid::API::MatrixWorkspaceValidator. + +*bases:* :py:obj:`mantid.api.MatrixWorkspaceValidator` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.MatrixWorkspaceValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/MultipleExperimentInfos.rst b/Code/Mantid/docs/source/api/python/mantid/api/MultipleExperimentInfos.rst new file mode 100644 index 000000000000..93aac8d0f37f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/MultipleExperimentInfos.rst @@ -0,0 +1,14 @@ +========================= + MultipleExperimentInfos +========================= + +This a python binding to the C++ class Mantid::API::MultipleExperimentInfos. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.MultipleExperimentInfos + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/MultipleFileProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/MultipleFileProperty.rst new file mode 100644 index 000000000000..269864deaecb --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/MultipleFileProperty.rst @@ -0,0 +1,15 @@ +====================== + MultipleFileProperty +====================== + +This a python binding to the C++ class Mantid::API::MultipleFileProperty. + +*bases:* :py:obj:`mantid.api.VectorVectorStringPropertyWithValue` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.MultipleFileProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/NumericAxis.rst b/Code/Mantid/docs/source/api/python/mantid/api/NumericAxis.rst new file mode 100644 index 000000000000..90a0a91fbfcf --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/NumericAxis.rst @@ -0,0 +1,15 @@ +============= + NumericAxis +============= + +This a python binding to the C++ class Mantid::API::NumericAxis. + +*bases:* :py:obj:`mantid.api.MantidAxis` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.NumericAxis + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/NumericAxisValidator.rst b/Code/Mantid/docs/source/api/python/mantid/api/NumericAxisValidator.rst new file mode 100644 index 000000000000..eed2b8025bcb --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/NumericAxisValidator.rst @@ -0,0 +1,15 @@ +====================== + NumericAxisValidator +====================== + +This a python binding to the C++ class Mantid::API::NumericAxisValidator. + +*bases:* :py:obj:`mantid.api.MatrixWorkspaceValidator` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.NumericAxisValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/Progress.rst b/Code/Mantid/docs/source/api/python/mantid/api/Progress.rst new file mode 100644 index 000000000000..e630b128c974 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/Progress.rst @@ -0,0 +1,15 @@ +========== + Progress +========== + +This a python binding to the C++ class Mantid::API::Progress. + +*bases:* :py:obj:`mantid.kernel.ProgressBase` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.Progress + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/PropertyManagerDataServiceImpl.rst b/Code/Mantid/docs/source/api/python/mantid/api/PropertyManagerDataServiceImpl.rst new file mode 100644 index 000000000000..edb7508ff900 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/PropertyManagerDataServiceImpl.rst @@ -0,0 +1,14 @@ +================================ + PropertyManagerDataServiceImpl +================================ + +This a python binding to the C++ class Mantid::API::PropertyManagerDataServiceImpl. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.PropertyManagerDataServiceImpl + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/PropertyMode.rst b/Code/Mantid/docs/source/api/python/mantid/api/PropertyMode.rst new file mode 100644 index 000000000000..371c7d2ba54a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/PropertyMode.rst @@ -0,0 +1,14 @@ +============== + PropertyMode +============== + +This a python binding to the C++ class Mantid::API::PropertyMode. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.PropertyMode + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/RawCountValidator.rst b/Code/Mantid/docs/source/api/python/mantid/api/RawCountValidator.rst new file mode 100644 index 000000000000..6d080bad41d4 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/RawCountValidator.rst @@ -0,0 +1,15 @@ +=================== + RawCountValidator +=================== + +This a python binding to the C++ class Mantid::API::RawCountValidator. + +*bases:* :py:obj:`mantid.api.MatrixWorkspaceValidator` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.RawCountValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/Run.rst b/Code/Mantid/docs/source/api/python/mantid/api/Run.rst new file mode 100644 index 000000000000..f5b3463ddc19 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/Run.rst @@ -0,0 +1,14 @@ +===== + Run +===== + +This a python binding to the C++ class Mantid::API::Run. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.Run + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/Sample.rst b/Code/Mantid/docs/source/api/python/mantid/api/Sample.rst new file mode 100644 index 000000000000..cd8af4d42b43 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/Sample.rst @@ -0,0 +1,14 @@ +======== + Sample +======== + +This a python binding to the C++ class Mantid::API::Sample. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.Sample + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/ScriptRepository.rst b/Code/Mantid/docs/source/api/python/mantid/api/ScriptRepository.rst new file mode 100644 index 000000000000..4d68b47c7a28 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/ScriptRepository.rst @@ -0,0 +1,14 @@ +================== + ScriptRepository +================== + +This a python binding to the C++ class Mantid::API::ScriptRepository. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.ScriptRepository + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/ScriptRepositoryFactory.rst b/Code/Mantid/docs/source/api/python/mantid/api/ScriptRepositoryFactory.rst new file mode 100644 index 000000000000..6c98217f6584 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/ScriptRepositoryFactory.rst @@ -0,0 +1,14 @@ +========================= + ScriptRepositoryFactory +========================= + +This a python binding to the C++ class Mantid::API::ScriptRepositoryFactory. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.ScriptRepositoryFactory + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/SpectraAxisValidator.rst b/Code/Mantid/docs/source/api/python/mantid/api/SpectraAxisValidator.rst new file mode 100644 index 000000000000..082e9f6117ad --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/SpectraAxisValidator.rst @@ -0,0 +1,15 @@ +====================== + SpectraAxisValidator +====================== + +This a python binding to the C++ class Mantid::API::SpectraAxisValidator. + +*bases:* :py:obj:`mantid.api.MatrixWorkspaceValidator` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.SpectraAxisValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/TextAxis.rst b/Code/Mantid/docs/source/api/python/mantid/api/TextAxis.rst new file mode 100644 index 000000000000..629fee6b719a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/TextAxis.rst @@ -0,0 +1,15 @@ +========== + TextAxis +========== + +This a python binding to the C++ class Mantid::API::TextAxis. + +*bases:* :py:obj:`mantid.api.MantidAxis` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.TextAxis + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/VectorVectorStringPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/api/VectorVectorStringPropertyWithValue.rst new file mode 100644 index 000000000000..8e3cc2fc8cbe --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/VectorVectorStringPropertyWithValue.rst @@ -0,0 +1,15 @@ +===================================== + VectorVectorStringPropertyWithValue +===================================== + +This a python binding to the C++ class Mantid::API::VectorVectorStringPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.VectorVectorStringPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/Workspace.rst b/Code/Mantid/docs/source/api/python/mantid/api/Workspace.rst new file mode 100644 index 000000000000..48a295f86682 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/Workspace.rst @@ -0,0 +1,15 @@ +=========== + Workspace +=========== + +This a python binding to the C++ class Mantid::API::Workspace. + +*bases:* :py:obj:`mantid.kernel.DataItem` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.Workspace + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceFactoryImpl.rst b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceFactoryImpl.rst new file mode 100644 index 000000000000..3fead333df54 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceFactoryImpl.rst @@ -0,0 +1,14 @@ +====================== + WorkspaceFactoryImpl +====================== + +This a python binding to the C++ class Mantid::API::WorkspaceFactoryImpl. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.WorkspaceFactoryImpl + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceGroup.rst b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceGroup.rst new file mode 100644 index 000000000000..31facfec47b2 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceGroup.rst @@ -0,0 +1,15 @@ +================ + WorkspaceGroup +================ + +This a python binding to the C++ class Mantid::API::WorkspaceGroup. + +*bases:* :py:obj:`mantid.api.Workspace` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.WorkspaceGroup + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceGroupProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceGroupProperty.rst new file mode 100644 index 000000000000..e5147a2ea08c --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceGroupProperty.rst @@ -0,0 +1,15 @@ +======================== + WorkspaceGroupProperty +======================== + +This a python binding to the C++ class Mantid::API::WorkspaceGroupProperty. + +*bases:* :py:obj:`mantid.api.WorkspaceGroupPropertyPropertyWithValue`, :py:obj:`mantid.api.IWorkspaceProperty` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.WorkspaceGroupProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceGroupPropertyPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceGroupPropertyPropertyWithValue.rst new file mode 100644 index 000000000000..8e32a69b8f73 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceGroupPropertyPropertyWithValue.rst @@ -0,0 +1,15 @@ +========================================= + WorkspaceGroupPropertyPropertyWithValue +========================================= + +This a python binding to the C++ class Mantid::API::WorkspaceGroupPropertyPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.WorkspaceGroupPropertyPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceHistory.rst b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceHistory.rst new file mode 100644 index 000000000000..8ea4232b7109 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceHistory.rst @@ -0,0 +1,14 @@ +================== + WorkspaceHistory +================== + +This a python binding to the C++ class Mantid::API::WorkspaceHistory. + + +.. module:`mantid.api` + +.. autoclass:: mantid.api.WorkspaceHistory + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceProperty.rst b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceProperty.rst new file mode 100644 index 000000000000..1dcf407a801c --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceProperty.rst @@ -0,0 +1,15 @@ +=================== + WorkspaceProperty +=================== + +This a python binding to the C++ class Mantid::API::WorkspaceProperty. + +*bases:* :py:obj:`mantid.api.WorkspacePropertyPropertyWithValue`, :py:obj:`mantid.api.IWorkspaceProperty` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.WorkspaceProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/WorkspacePropertyPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/api/WorkspacePropertyPropertyWithValue.rst new file mode 100644 index 000000000000..b36b2fb8c174 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/WorkspacePropertyPropertyWithValue.rst @@ -0,0 +1,15 @@ +==================================== + WorkspacePropertyPropertyWithValue +==================================== + +This a python binding to the C++ class Mantid::API::WorkspacePropertyPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.WorkspacePropertyPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceUnitValidator.rst b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceUnitValidator.rst new file mode 100644 index 000000000000..f28b60791245 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/WorkspaceUnitValidator.rst @@ -0,0 +1,15 @@ +======================== + WorkspaceUnitValidator +======================== + +This a python binding to the C++ class Mantid::API::WorkspaceUnitValidator. + +*bases:* :py:obj:`mantid.api.MatrixWorkspaceValidator` + +.. module:`mantid.api` + +.. autoclass:: mantid.api.WorkspaceUnitValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/api/index.rst b/Code/Mantid/docs/source/api/python/mantid/api/index.rst new file mode 100644 index 000000000000..b8f1c1e49152 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/api/index.rst @@ -0,0 +1,12 @@ +=================== + :mod:`mantid.api` +=================== + +.. module:: mantid.api + +.. toctree:: + + :glob: + :maxdepth: 1 + + * \ No newline at end of file diff --git a/Code/Mantid/docs/source/api/python/mantid/apiVersion.rst b/Code/Mantid/docs/source/api/python/mantid/apiVersion.rst new file mode 100644 index 000000000000..e1b8e8ae4792 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/apiVersion.rst @@ -0,0 +1,8 @@ +============ + apiVersion +============ + +.. module:`mantid` + +.. autofunction:: mantid.apiVersion + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/AngleUnits.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/AngleUnits.rst new file mode 100644 index 000000000000..6949caa44ff3 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/AngleUnits.rst @@ -0,0 +1,14 @@ +============ + AngleUnits +============ + +This a python binding to the C++ class Mantid::Geometry::AngleUnits. + + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.AngleUnits + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/BoundingBox.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/BoundingBox.rst new file mode 100644 index 000000000000..9544a95cf83f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/BoundingBox.rst @@ -0,0 +1,14 @@ +============= + BoundingBox +============= + +This a python binding to the C++ class Mantid::Geometry::BoundingBox. + + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.BoundingBox + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/CompAssembly.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/CompAssembly.rst new file mode 100644 index 000000000000..b19798bf25b5 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/CompAssembly.rst @@ -0,0 +1,15 @@ +============== + CompAssembly +============== + +This a python binding to the C++ class Mantid::Geometry::CompAssembly. + +*bases:* :py:obj:`mantid.geometry.ICompAssembly`, :py:obj:`mantid.geometry.Component` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.CompAssembly + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/Component.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/Component.rst new file mode 100644 index 000000000000..d4d7bde5c2c1 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/Component.rst @@ -0,0 +1,15 @@ +=========== + Component +=========== + +This a python binding to the C++ class Mantid::Geometry::Component. + +*bases:* :py:obj:`mantid.geometry.IComponent` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.Component + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/Detector.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/Detector.rst new file mode 100644 index 000000000000..69d0a0e4d924 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/Detector.rst @@ -0,0 +1,15 @@ +========== + Detector +========== + +This a python binding to the C++ class Mantid::Geometry::Detector. + +*bases:* :py:obj:`mantid.geometry.IDetector`, :py:obj:`mantid.geometry.ObjComponent` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.Detector + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/DetectorGroup.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/DetectorGroup.rst new file mode 100644 index 000000000000..a120a43a2f45 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/DetectorGroup.rst @@ -0,0 +1,15 @@ +=============== + DetectorGroup +=============== + +This a python binding to the C++ class Mantid::Geometry::DetectorGroup. + +*bases:* :py:obj:`mantid.geometry.IDetector` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.DetectorGroup + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/Goniometer.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/Goniometer.rst new file mode 100644 index 000000000000..d55576e06168 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/Goniometer.rst @@ -0,0 +1,14 @@ +============ + Goniometer +============ + +This a python binding to the C++ class Mantid::Geometry::Goniometer. + + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.Goniometer + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/ICompAssembly.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/ICompAssembly.rst new file mode 100644 index 000000000000..66d325a35dfb --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/ICompAssembly.rst @@ -0,0 +1,15 @@ +=============== + ICompAssembly +=============== + +This a python binding to the C++ class Mantid::Geometry::ICompAssembly. + +*bases:* :py:obj:`mantid.geometry.IComponent` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.ICompAssembly + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/IComponent.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/IComponent.rst new file mode 100644 index 000000000000..4a5609819649 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/IComponent.rst @@ -0,0 +1,14 @@ +============ + IComponent +============ + +This a python binding to the C++ class Mantid::Geometry::IComponent. + + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.IComponent + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/IDetector.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/IDetector.rst new file mode 100644 index 000000000000..dab8f82377b4 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/IDetector.rst @@ -0,0 +1,15 @@ +=========== + IDetector +=========== + +This a python binding to the C++ class Mantid::Geometry::IDetector. + +*bases:* :py:obj:`mantid.geometry.IObjComponent` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.IDetector + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/IMDDimension.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/IMDDimension.rst new file mode 100644 index 000000000000..0dec8ddc6369 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/IMDDimension.rst @@ -0,0 +1,14 @@ +============== + IMDDimension +============== + +This a python binding to the C++ class Mantid::Geometry::IMDDimension. + + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.IMDDimension + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/IObjCompAssembly.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/IObjCompAssembly.rst new file mode 100644 index 000000000000..fd0ac08f857e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/IObjCompAssembly.rst @@ -0,0 +1,15 @@ +================== + IObjCompAssembly +================== + +This a python binding to the C++ class Mantid::Geometry::ObjCompAssembly. + +*bases:* :py:obj:`mantid.geometry.ICompAssembly`, :py:obj:`mantid.geometry.ObjComponent` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.IObjCompAssembly + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/IObjComponent.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/IObjComponent.rst new file mode 100644 index 000000000000..35152e206e46 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/IObjComponent.rst @@ -0,0 +1,15 @@ +=============== + IObjComponent +=============== + +This a python binding to the C++ class Mantid::Geometry::IObjComponent. + +*bases:* :py:obj:`mantid.geometry.IComponent` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.IObjComponent + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/Instrument.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/Instrument.rst new file mode 100644 index 000000000000..281c87a04dd3 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/Instrument.rst @@ -0,0 +1,15 @@ +============ + Instrument +============ + +This a python binding to the C++ class Mantid::Geometry::Instrument. + +*bases:* :py:obj:`mantid.geometry.CompAssembly` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.Instrument + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/ObjComponent.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/ObjComponent.rst new file mode 100644 index 000000000000..2f4bd77d470b --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/ObjComponent.rst @@ -0,0 +1,15 @@ +============== + ObjComponent +============== + +This a python binding to the C++ class Mantid::Geometry::ObjComponent. + +*bases:* :py:obj:`mantid.geometry.IObjComponent`, :py:obj:`mantid.geometry.Component` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.ObjComponent + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/Object.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/Object.rst new file mode 100644 index 000000000000..e021aa5945d5 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/Object.rst @@ -0,0 +1,14 @@ +======== + Object +======== + +This a python binding to the C++ class Mantid::Geometry::Object. + + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.Object + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/OrientedLattice.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/OrientedLattice.rst new file mode 100644 index 000000000000..851843830f06 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/OrientedLattice.rst @@ -0,0 +1,15 @@ +================= + OrientedLattice +================= + +This a python binding to the C++ class Mantid::Geometry::OrientedLattice. + +*bases:* :py:obj:`mantid.geometry.UnitCell` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.OrientedLattice + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/PointingAlong.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/PointingAlong.rst new file mode 100644 index 000000000000..4c0d1022881d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/PointingAlong.rst @@ -0,0 +1,14 @@ +=============== + PointingAlong +=============== + +This a python binding to the C++ class Mantid::Geometry::PointingAlong. + + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.PointingAlong + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/RectangularDetector.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/RectangularDetector.rst new file mode 100644 index 000000000000..c52ef9a2bc2e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/RectangularDetector.rst @@ -0,0 +1,15 @@ +===================== + RectangularDetector +===================== + +This a python binding to the C++ class Mantid::Geometry::RectangularDetector. + +*bases:* :py:obj:`mantid.geometry.CompAssembly`, :py:obj:`mantid.geometry.IObjComponent` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.RectangularDetector + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/RectangularDetectorPixel.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/RectangularDetectorPixel.rst new file mode 100644 index 000000000000..ac489c2a18e7 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/RectangularDetectorPixel.rst @@ -0,0 +1,15 @@ +========================== + RectangularDetectorPixel +========================== + +This a python binding to the C++ class Mantid::Geometry::RectangularDetectorPixel. + +*bases:* :py:obj:`mantid.geometry.Detector` + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.RectangularDetectorPixel + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/ReferenceFrame.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/ReferenceFrame.rst new file mode 100644 index 000000000000..84bd97e43113 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/ReferenceFrame.rst @@ -0,0 +1,14 @@ +================ + ReferenceFrame +================ + +This a python binding to the C++ class Mantid::Geometry::ReferenceFrame. + + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.ReferenceFrame + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/UnitCell.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/UnitCell.rst new file mode 100644 index 000000000000..b98442259f13 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/UnitCell.rst @@ -0,0 +1,14 @@ +========== + UnitCell +========== + +This a python binding to the C++ class Mantid::Geometry::UnitCell. + + +.. module:`mantid.geometry` + +.. autoclass:: mantid.geometry.UnitCell + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/geometry/index.rst b/Code/Mantid/docs/source/api/python/mantid/geometry/index.rst new file mode 100644 index 000000000000..d200d530a9a9 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/geometry/index.rst @@ -0,0 +1,11 @@ +======================== + :mod:`mantid.geometry` +======================== + +.. module:: mantid.geometry + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/Code/Mantid/docs/source/api/python/mantid/index.rst b/Code/Mantid/docs/source/api/python/mantid/index.rst new file mode 100644 index 000000000000..1d33eea5b034 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/index.rst @@ -0,0 +1,25 @@ +===================================== + :mod:`mantid` --- Framework package +===================================== + +.. module:: mantid + +This package defines the Python interface to the Mantid C++ framework libraries for actions such as running algorithms and accessing workspaces etc. + +Functions +######### + +.. toctree:: + :maxdepth: 1 + + apiVersion + +Submodules +########## + +.. toctree:: + :maxdepth: 1 + + kernel/index + geometry/index + api/index diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/BoolFilteredTimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/BoolFilteredTimeSeriesProperty.rst new file mode 100644 index 000000000000..6ba2aebeefc8 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/BoolFilteredTimeSeriesProperty.rst @@ -0,0 +1,15 @@ +================================ + BoolFilteredTimeSeriesProperty +================================ + +This a python binding to the C++ class Mantid::Kernel::FilteredTimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.BoolTimeSeriesProperty` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.BoolFilteredTimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/BoolPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/BoolPropertyWithValue.rst new file mode 100644 index 000000000000..d80ae132ffaa --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/BoolPropertyWithValue.rst @@ -0,0 +1,15 @@ +======================= + BoolPropertyWithValue +======================= + +This a python binding to the C++ class Mantid::Kernel::BoolPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.BoolPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/BoolTimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/BoolTimeSeriesProperty.rst new file mode 100644 index 000000000000..b9e621e50e2d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/BoolTimeSeriesProperty.rst @@ -0,0 +1,15 @@ +======================== + BoolTimeSeriesProperty +======================== + +This a python binding to the C++ class Mantid::Kernel::TimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.BoolTimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/CIntArrayProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/CIntArrayProperty.rst new file mode 100644 index 000000000000..46e22bbdd0cb --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/CIntArrayProperty.rst @@ -0,0 +1,15 @@ +=================== + CIntArrayProperty +=================== + +This a python binding to the C++ class Mantid::Kernel::ArrayProperty. + +*bases:* :py:obj:`mantid.kernel.VectorIntPropertyWithValue` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.CIntArrayProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/CompositeValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/CompositeValidator.rst new file mode 100644 index 000000000000..2e930f463e0e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/CompositeValidator.rst @@ -0,0 +1,15 @@ +==================== + CompositeValidator +==================== + +This a python binding to the C++ class Mantid::Kernel::CompositeValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.CompositeValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/ConfigServiceImpl.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/ConfigServiceImpl.rst new file mode 100644 index 000000000000..28824268f45e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/ConfigServiceImpl.rst @@ -0,0 +1,14 @@ +=================== + ConfigServiceImpl +=================== + +This a python binding to the C++ class Mantid::Kernel::ConfigServiceImpl. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.ConfigServiceImpl + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/DataItem.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/DataItem.rst new file mode 100644 index 000000000000..24607229689d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/DataItem.rst @@ -0,0 +1,14 @@ +========== + DataItem +========== + +This a python binding to the C++ class Mantid::Kernel::DataItem. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.DataItem + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/DateAndTime.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/DateAndTime.rst new file mode 100644 index 000000000000..37f4cb092988 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/DateAndTime.rst @@ -0,0 +1,14 @@ +============= + DateAndTime +============= + +This a python binding to the C++ class Mantid::Kernel::DateAndTime. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.DateAndTime + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/DeltaEMode.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/DeltaEMode.rst new file mode 100644 index 000000000000..5ffa55550f17 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/DeltaEMode.rst @@ -0,0 +1,14 @@ +============ + DeltaEMode +============ + +This a python binding to the C++ class Mantid::Kernel::DeltaEMode. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.DeltaEMode + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/DeltaEModeType.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/DeltaEModeType.rst new file mode 100644 index 000000000000..2e474f4948ba --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/DeltaEModeType.rst @@ -0,0 +1,14 @@ +================ + DeltaEModeType +================ + +This a python binding to the C++ class Mantid::Kernel::DeltaEMode. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.DeltaEModeType + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Direction.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Direction.rst new file mode 100644 index 000000000000..d60874ac61ef --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Direction.rst @@ -0,0 +1,14 @@ +=========== + Direction +=========== + +This a python binding to the C++ class Mantid::Kernel::Direction. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Direction + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/EnabledWhenProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/EnabledWhenProperty.rst new file mode 100644 index 000000000000..ad95e60f2cb3 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/EnabledWhenProperty.rst @@ -0,0 +1,15 @@ +===================== + EnabledWhenProperty +===================== + +This a python binding to the C++ class Mantid::Kernel::EnabledWhenProperty. + +*bases:* :py:obj:`mantid.kernel.IPropertySettings` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.EnabledWhenProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FacilityInfo.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FacilityInfo.rst new file mode 100644 index 000000000000..dcfefa1eefbe --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FacilityInfo.rst @@ -0,0 +1,14 @@ +============== + FacilityInfo +============== + +This a python binding to the C++ class Mantid::Kernel::FacilityInfo. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FacilityInfo + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayBoundedValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayBoundedValidator.rst new file mode 100644 index 000000000000..f8d5e24b22b9 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayBoundedValidator.rst @@ -0,0 +1,15 @@ +============================ + FloatArrayBoundedValidator +============================ + +This a python binding to the C++ class Mantid::Kernel::ArrayBoundedValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FloatArrayBoundedValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayLengthValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayLengthValidator.rst new file mode 100644 index 000000000000..dc34b964351f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayLengthValidator.rst @@ -0,0 +1,15 @@ +=========================== + FloatArrayLengthValidator +=========================== + +This a python binding to the C++ class Mantid::Kernel::ArrayLengthValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FloatArrayLengthValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayMandatoryValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayMandatoryValidator.rst new file mode 100644 index 000000000000..78ee99712df0 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayMandatoryValidator.rst @@ -0,0 +1,15 @@ +============================== + FloatArrayMandatoryValidator +============================== + +This a python binding to the C++ class Mantid::Kernel::MandatoryValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FloatArrayMandatoryValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayProperty.rst new file mode 100644 index 000000000000..e1cfab9fbeb2 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatArrayProperty.rst @@ -0,0 +1,15 @@ +==================== + FloatArrayProperty +==================== + +This a python binding to the C++ class Mantid::Kernel::ArrayProperty. + +*bases:* :py:obj:`mantid.kernel.VectorFloatPropertyWithValue` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FloatArrayProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FloatBoundedValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatBoundedValidator.rst new file mode 100644 index 000000000000..7ffbf1776ecd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatBoundedValidator.rst @@ -0,0 +1,15 @@ +======================= + FloatBoundedValidator +======================= + +This a python binding to the C++ class Mantid::Kernel::FloatBoundedValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FloatBoundedValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FloatFilteredTimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatFilteredTimeSeriesProperty.rst new file mode 100644 index 000000000000..4f1c5ec0dfb9 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatFilteredTimeSeriesProperty.rst @@ -0,0 +1,15 @@ +================================= + FloatFilteredTimeSeriesProperty +================================= + +This a python binding to the C++ class Mantid::Kernel::FilteredTimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.FloatTimeSeriesProperty` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FloatFilteredTimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FloatMandatoryValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatMandatoryValidator.rst new file mode 100644 index 000000000000..813510b0d673 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatMandatoryValidator.rst @@ -0,0 +1,15 @@ +========================= + FloatMandatoryValidator +========================= + +This a python binding to the C++ class Mantid::Kernel::MandatoryValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FloatMandatoryValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FloatPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatPropertyWithValue.rst new file mode 100644 index 000000000000..d85e285d9f64 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatPropertyWithValue.rst @@ -0,0 +1,15 @@ +======================== + FloatPropertyWithValue +======================== + +This a python binding to the C++ class Mantid::Kernel::FloatPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FloatPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/FloatTimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatTimeSeriesProperty.rst new file mode 100644 index 000000000000..f4dfe350c096 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/FloatTimeSeriesProperty.rst @@ -0,0 +1,15 @@ +========================= + FloatTimeSeriesProperty +========================= + +This a python binding to the C++ class Mantid::Kernel::TimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.FloatTimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IPropertyManager.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IPropertyManager.rst new file mode 100644 index 000000000000..97faef639cb7 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IPropertyManager.rst @@ -0,0 +1,14 @@ +================== + IPropertyManager +================== + +This a python binding to the C++ class Mantid::Kernel::IPropertyManager. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IPropertyManager + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IPropertySettings.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IPropertySettings.rst new file mode 100644 index 000000000000..18ace3e80344 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IPropertySettings.rst @@ -0,0 +1,14 @@ +=================== + IPropertySettings +=================== + +This a python binding to the C++ class Mantid::Kernel::IPropertySettings. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IPropertySettings + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IValidator.rst new file mode 100644 index 000000000000..350b9c58a430 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IValidator.rst @@ -0,0 +1,14 @@ +============ + IValidator +============ + +This a python binding to the C++ class Mantid::Kernel::IValidator. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/InstrumentInfo.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/InstrumentInfo.rst new file mode 100644 index 000000000000..d15e0d67f4c1 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/InstrumentInfo.rst @@ -0,0 +1,14 @@ +================ + InstrumentInfo +================ + +This a python binding to the C++ class Mantid::Kernel::InstrumentInfo. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.InstrumentInfo + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Int32FilteredTimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Int32FilteredTimeSeriesProperty.rst new file mode 100644 index 000000000000..247464d4eac4 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Int32FilteredTimeSeriesProperty.rst @@ -0,0 +1,15 @@ +================================= + Int32FilteredTimeSeriesProperty +================================= + +This a python binding to the C++ class Mantid::Kernel::FilteredTimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.Int32TimeSeriesProperty` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Int32FilteredTimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Int32TimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Int32TimeSeriesProperty.rst new file mode 100644 index 000000000000..163a700f52c8 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Int32TimeSeriesProperty.rst @@ -0,0 +1,15 @@ +========================= + Int32TimeSeriesProperty +========================= + +This a python binding to the C++ class Mantid::Kernel::TimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Int32TimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Int64FilteredTimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Int64FilteredTimeSeriesProperty.rst new file mode 100644 index 000000000000..75d1dae072d1 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Int64FilteredTimeSeriesProperty.rst @@ -0,0 +1,15 @@ +================================= + Int64FilteredTimeSeriesProperty +================================= + +This a python binding to the C++ class Mantid::Kernel::FilteredTimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.Int64TimeSeriesProperty` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Int64FilteredTimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Int64TimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Int64TimeSeriesProperty.rst new file mode 100644 index 000000000000..3e6b5d7703ef --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Int64TimeSeriesProperty.rst @@ -0,0 +1,15 @@ +========================= + Int64TimeSeriesProperty +========================= + +This a python binding to the C++ class Mantid::Kernel::TimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Int64TimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayBoundedValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayBoundedValidator.rst new file mode 100644 index 000000000000..fea93a4eb77e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayBoundedValidator.rst @@ -0,0 +1,15 @@ +========================== + IntArrayBoundedValidator +========================== + +This a python binding to the C++ class Mantid::Kernel::ArrayBoundedValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IntArrayBoundedValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayLengthValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayLengthValidator.rst new file mode 100644 index 000000000000..2c298f254724 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayLengthValidator.rst @@ -0,0 +1,15 @@ +========================= + IntArrayLengthValidator +========================= + +This a python binding to the C++ class Mantid::Kernel::ArrayLengthValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IntArrayLengthValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayMandatoryValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayMandatoryValidator.rst new file mode 100644 index 000000000000..d5db798c5d18 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayMandatoryValidator.rst @@ -0,0 +1,15 @@ +============================ + IntArrayMandatoryValidator +============================ + +This a python binding to the C++ class Mantid::Kernel::MandatoryValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IntArrayMandatoryValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayProperty.rst new file mode 100644 index 000000000000..0739af28d586 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IntArrayProperty.rst @@ -0,0 +1,15 @@ +================== + IntArrayProperty +================== + +This a python binding to the C++ class Mantid::Kernel::ArrayProperty. + +*bases:* :py:obj:`mantid.kernel.VectorLongPropertyWithValue` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IntArrayProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IntBoundedValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IntBoundedValidator.rst new file mode 100644 index 000000000000..9776273dda2d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IntBoundedValidator.rst @@ -0,0 +1,15 @@ +===================== + IntBoundedValidator +===================== + +This a python binding to the C++ class Mantid::Kernel::IntBoundedValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IntBoundedValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IntListValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IntListValidator.rst new file mode 100644 index 000000000000..52b10f540bd2 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IntListValidator.rst @@ -0,0 +1,15 @@ +================== + IntListValidator +================== + +This a python binding to the C++ class Mantid::Kernel::IntListValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IntListValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IntMandatoryValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IntMandatoryValidator.rst new file mode 100644 index 000000000000..e575390ee854 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IntMandatoryValidator.rst @@ -0,0 +1,15 @@ +======================= + IntMandatoryValidator +======================= + +This a python binding to the C++ class Mantid::Kernel::MandatoryValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IntMandatoryValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/IntPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/IntPropertyWithValue.rst new file mode 100644 index 000000000000..f575a00e9b8f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/IntPropertyWithValue.rst @@ -0,0 +1,15 @@ +====================== + IntPropertyWithValue +====================== + +This a python binding to the C++ class Mantid::Kernel::IntPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.IntPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Label.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Label.rst new file mode 100644 index 000000000000..d7c11899f141 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Label.rst @@ -0,0 +1,15 @@ +======= + Label +======= + +This a python binding to the C++ class Mantid::Kernel::Label. + +*bases:* :py:obj:`mantid.kernel.Unit` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Label + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/LogFilter.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/LogFilter.rst new file mode 100644 index 000000000000..63ad422d754e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/LogFilter.rst @@ -0,0 +1,14 @@ +=========== + LogFilter +=========== + +This a python binding to the C++ class Mantid::Kernel::LogFilter. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.LogFilter + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Logger.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Logger.rst new file mode 100644 index 000000000000..cb2b4c2fcbcd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Logger.rst @@ -0,0 +1,14 @@ +======== + Logger +======== + +This a python binding to the C++ class Mantid::Kernel::Logger. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Logger + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/LongLongPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/LongLongPropertyWithValue.rst new file mode 100644 index 000000000000..91f2879447dd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/LongLongPropertyWithValue.rst @@ -0,0 +1,15 @@ +=========================== + LongLongPropertyWithValue +=========================== + +This a python binding to the C++ class Mantid::Kernel::LongLongPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.LongLongPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/LongPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/LongPropertyWithValue.rst new file mode 100644 index 000000000000..b14955194b02 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/LongPropertyWithValue.rst @@ -0,0 +1,15 @@ +======================= + LongPropertyWithValue +======================= + +This a python binding to the C++ class Mantid::Kernel::LongPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.LongPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Material.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Material.rst new file mode 100644 index 000000000000..a6fa3b14f0f1 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Material.rst @@ -0,0 +1,14 @@ +========== + Material +========== + +This a python binding to the C++ class Mantid::Kernel::Material. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Material + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/MemoryStats.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/MemoryStats.rst new file mode 100644 index 000000000000..4ae522f2c71f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/MemoryStats.rst @@ -0,0 +1,14 @@ +============= + MemoryStats +============= + +This a python binding to the C++ class Mantid::Kernel::MemoryStats. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.MemoryStats + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/NullValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/NullValidator.rst new file mode 100644 index 000000000000..5d3719ec62a9 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/NullValidator.rst @@ -0,0 +1,15 @@ +=============== + NullValidator +=============== + +This a python binding to the C++ class Mantid::Kernel::NullValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.NullValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/ProgressBase.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/ProgressBase.rst new file mode 100644 index 000000000000..c3b9c2eec779 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/ProgressBase.rst @@ -0,0 +1,14 @@ +============== + ProgressBase +============== + +This a python binding to the C++ class Mantid::Kernel::ProgressBase. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.ProgressBase + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Property.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Property.rst new file mode 100644 index 000000000000..a9bb49c93683 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Property.rst @@ -0,0 +1,14 @@ +========== + Property +========== + +This a python binding to the C++ class Mantid::Kernel::Property. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Property + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/PropertyCriterion.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/PropertyCriterion.rst new file mode 100644 index 000000000000..98651f87a83d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/PropertyCriterion.rst @@ -0,0 +1,14 @@ +=================== + PropertyCriterion +=================== + +This a python binding to the C++ class Mantid::Kernel::PropertyCriterion. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.PropertyCriterion + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/PropertyHistory.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/PropertyHistory.rst new file mode 100644 index 000000000000..1053382913ed --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/PropertyHistory.rst @@ -0,0 +1,14 @@ +================= + PropertyHistory +================= + +This a python binding to the C++ class Mantid::Kernel::PropertyHistory. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.PropertyHistory + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/PropertyManager.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/PropertyManager.rst new file mode 100644 index 000000000000..260467770db7 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/PropertyManager.rst @@ -0,0 +1,15 @@ +================= + PropertyManager +================= + +This a python binding to the C++ class Mantid::Kernel::PropertyManager. + +*bases:* :py:obj:`mantid.kernel.IPropertyManager` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.PropertyManager + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Quat.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Quat.rst new file mode 100644 index 000000000000..cc2cd3702584 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Quat.rst @@ -0,0 +1,14 @@ +====== + Quat +====== + +This a python binding to the C++ class Mantid::Kernel::Quat. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Quat + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Stats.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Stats.rst new file mode 100644 index 000000000000..46bdfe52c349 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Stats.rst @@ -0,0 +1,14 @@ +======= + Stats +======= + +This a python binding to the C++ class Mantid::Kernel::Stats. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Stats + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/StringArrayLengthValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/StringArrayLengthValidator.rst new file mode 100644 index 000000000000..1d797d0433ee --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/StringArrayLengthValidator.rst @@ -0,0 +1,15 @@ +============================ + StringArrayLengthValidator +============================ + +This a python binding to the C++ class Mantid::Kernel::ArrayLengthValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.StringArrayLengthValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/StringArrayMandatoryValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/StringArrayMandatoryValidator.rst new file mode 100644 index 000000000000..17fd1ccf7550 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/StringArrayMandatoryValidator.rst @@ -0,0 +1,15 @@ +=============================== + StringArrayMandatoryValidator +=============================== + +This a python binding to the C++ class Mantid::Kernel::MandatoryValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.StringArrayMandatoryValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/StringArrayProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/StringArrayProperty.rst new file mode 100644 index 000000000000..d8e271a117e7 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/StringArrayProperty.rst @@ -0,0 +1,15 @@ +===================== + StringArrayProperty +===================== + +This a python binding to the C++ class Mantid::Kernel::ArrayProperty. + +*bases:* :py:obj:`mantid.kernel.VectorStringPropertyWithValue` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.StringArrayProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/StringFilteredTimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/StringFilteredTimeSeriesProperty.rst new file mode 100644 index 000000000000..004c7906f13f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/StringFilteredTimeSeriesProperty.rst @@ -0,0 +1,15 @@ +================================== + StringFilteredTimeSeriesProperty +================================== + +This a python binding to the C++ class Mantid::Kernel::FilteredTimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.StringTimeSeriesProperty` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.StringFilteredTimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/StringListValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/StringListValidator.rst new file mode 100644 index 000000000000..9b8a4ce0588a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/StringListValidator.rst @@ -0,0 +1,15 @@ +===================== + StringListValidator +===================== + +This a python binding to the C++ class Mantid::Kernel::StringListValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.StringListValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/StringMandatoryValidator.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/StringMandatoryValidator.rst new file mode 100644 index 000000000000..9bb4da9c412a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/StringMandatoryValidator.rst @@ -0,0 +1,15 @@ +========================== + StringMandatoryValidator +========================== + +This a python binding to the C++ class Mantid::Kernel::MandatoryValidator. + +*bases:* :py:obj:`mantid.kernel.IValidator` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.StringMandatoryValidator + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/StringPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/StringPropertyWithValue.rst new file mode 100644 index 000000000000..dc658734720c --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/StringPropertyWithValue.rst @@ -0,0 +1,15 @@ +========================= + StringPropertyWithValue +========================= + +This a python binding to the C++ class Mantid::Kernel::StringPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.StringPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/StringTimeSeriesProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/StringTimeSeriesProperty.rst new file mode 100644 index 000000000000..363219ce64ba --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/StringTimeSeriesProperty.rst @@ -0,0 +1,15 @@ +========================== + StringTimeSeriesProperty +========================== + +This a python binding to the C++ class Mantid::Kernel::TimeSeriesProperty. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.StringTimeSeriesProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/TimeSeriesPropertyStatistics.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/TimeSeriesPropertyStatistics.rst new file mode 100644 index 000000000000..4042a5f0ed7a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/TimeSeriesPropertyStatistics.rst @@ -0,0 +1,14 @@ +============================== + TimeSeriesPropertyStatistics +============================== + +This a python binding to the C++ class Mantid::Kernel::TimeSeriesPropertyStatistics. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.TimeSeriesPropertyStatistics + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/UIntPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/UIntPropertyWithValue.rst new file mode 100644 index 000000000000..e3cc4207ceb9 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/UIntPropertyWithValue.rst @@ -0,0 +1,15 @@ +======================= + UIntPropertyWithValue +======================= + +This a python binding to the C++ class Mantid::Kernel::UIntPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.UIntPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/ULongLongPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/ULongLongPropertyWithValue.rst new file mode 100644 index 000000000000..78d7e087dc26 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/ULongLongPropertyWithValue.rst @@ -0,0 +1,15 @@ +============================ + ULongLongPropertyWithValue +============================ + +This a python binding to the C++ class Mantid::Kernel::ULongLongPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.ULongLongPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/ULongPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/ULongPropertyWithValue.rst new file mode 100644 index 000000000000..387b564492ae --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/ULongPropertyWithValue.rst @@ -0,0 +1,15 @@ +======================== + ULongPropertyWithValue +======================== + +This a python binding to the C++ class Mantid::Kernel::ULongPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.ULongPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/Unit.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/Unit.rst new file mode 100644 index 000000000000..954862014cbe --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/Unit.rst @@ -0,0 +1,14 @@ +====== + Unit +====== + +This a python binding to the C++ class Mantid::Kernel::Unit. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.Unit + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/UnitConversion.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/UnitConversion.rst new file mode 100644 index 000000000000..ff9bf8859395 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/UnitConversion.rst @@ -0,0 +1,14 @@ +================ + UnitConversion +================ + +This a python binding to the C++ class Mantid::Kernel::UnitConversion. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.UnitConversion + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/UnitFactoryImpl.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/UnitFactoryImpl.rst new file mode 100644 index 000000000000..9bd035bc138c --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/UnitFactoryImpl.rst @@ -0,0 +1,14 @@ +================= + UnitFactoryImpl +================= + +This a python binding to the C++ class Mantid::Kernel::UnitFactoryImpl. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.UnitFactoryImpl + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/UnitLabel.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/UnitLabel.rst new file mode 100644 index 000000000000..838a891d76d2 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/UnitLabel.rst @@ -0,0 +1,14 @@ +=========== + UnitLabel +=========== + +This a python binding to the C++ class Mantid::Kernel::UnitLabel. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.UnitLabel + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/UnsignedIntArrayProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/UnsignedIntArrayProperty.rst new file mode 100644 index 000000000000..13a0710d5756 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/UnsignedIntArrayProperty.rst @@ -0,0 +1,15 @@ +========================== + UnsignedIntArrayProperty +========================== + +This a python binding to the C++ class Mantid::Kernel::ArrayProperty. + +*bases:* :py:obj:`mantid.kernel.VectorULongPropertyWithValue` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.UnsignedIntArrayProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/V3D.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/V3D.rst new file mode 100644 index 000000000000..fdb5c4f166f7 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/V3D.rst @@ -0,0 +1,14 @@ +===== + V3D +===== + +This a python binding to the C++ class Mantid::Kernel::V3D. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.V3D + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VMD.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VMD.rst new file mode 100644 index 000000000000..1178b414046d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VMD.rst @@ -0,0 +1,14 @@ +===== + VMD +===== + +This a python binding to the C++ class Mantid::Kernel::VMD. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VMD + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VectorBoolPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorBoolPropertyWithValue.rst new file mode 100644 index 000000000000..6e395edbc27a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorBoolPropertyWithValue.rst @@ -0,0 +1,15 @@ +============================= + VectorBoolPropertyWithValue +============================= + +This a python binding to the C++ class Mantid::Kernel::VectorBoolPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VectorBoolPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VectorFloatPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorFloatPropertyWithValue.rst new file mode 100644 index 000000000000..684b1bc52846 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorFloatPropertyWithValue.rst @@ -0,0 +1,15 @@ +============================== + VectorFloatPropertyWithValue +============================== + +This a python binding to the C++ class Mantid::Kernel::VectorFloatPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VectorFloatPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VectorIntPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorIntPropertyWithValue.rst new file mode 100644 index 000000000000..0fa0c89e0fcb --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorIntPropertyWithValue.rst @@ -0,0 +1,15 @@ +============================ + VectorIntPropertyWithValue +============================ + +This a python binding to the C++ class Mantid::Kernel::VectorIntPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VectorIntPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VectorLongLongPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorLongLongPropertyWithValue.rst new file mode 100644 index 000000000000..e40e8b6a672f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorLongLongPropertyWithValue.rst @@ -0,0 +1,15 @@ +================================= + VectorLongLongPropertyWithValue +================================= + +This a python binding to the C++ class Mantid::Kernel::VectorLongLongPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VectorLongLongPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VectorLongPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorLongPropertyWithValue.rst new file mode 100644 index 000000000000..f46a57fac942 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorLongPropertyWithValue.rst @@ -0,0 +1,15 @@ +============================= + VectorLongPropertyWithValue +============================= + +This a python binding to the C++ class Mantid::Kernel::VectorLongPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VectorLongPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VectorStringPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorStringPropertyWithValue.rst new file mode 100644 index 000000000000..e8af81f9eb4d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorStringPropertyWithValue.rst @@ -0,0 +1,15 @@ +=============================== + VectorStringPropertyWithValue +=============================== + +This a python binding to the C++ class Mantid::Kernel::VectorStringPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VectorStringPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VectorUIntPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorUIntPropertyWithValue.rst new file mode 100644 index 000000000000..c17f7b0b70c1 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorUIntPropertyWithValue.rst @@ -0,0 +1,15 @@ +============================= + VectorUIntPropertyWithValue +============================= + +This a python binding to the C++ class Mantid::Kernel::VectorUIntPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VectorUIntPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VectorULongLongPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorULongLongPropertyWithValue.rst new file mode 100644 index 000000000000..70fb98a83f4d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorULongLongPropertyWithValue.rst @@ -0,0 +1,15 @@ +================================== + VectorULongLongPropertyWithValue +================================== + +This a python binding to the C++ class Mantid::Kernel::VectorULongLongPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VectorULongLongPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VectorULongPropertyWithValue.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorULongPropertyWithValue.rst new file mode 100644 index 000000000000..74b26248db2f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VectorULongPropertyWithValue.rst @@ -0,0 +1,15 @@ +============================== + VectorULongPropertyWithValue +============================== + +This a python binding to the C++ class Mantid::Kernel::VectorULongPropertyWithValue. + +*bases:* :py:obj:`mantid.kernel.Property` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VectorULongPropertyWithValue + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/VisibleWhenProperty.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/VisibleWhenProperty.rst new file mode 100644 index 000000000000..eec52dd2f0d1 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/VisibleWhenProperty.rst @@ -0,0 +1,15 @@ +===================== + VisibleWhenProperty +===================== + +This a python binding to the C++ class Mantid::Kernel::VisibleWhenProperty. + +*bases:* :py:obj:`mantid.kernel.EnabledWhenProperty` + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.VisibleWhenProperty + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/index.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/index.rst new file mode 100644 index 000000000000..68507c1f7fdd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/index.rst @@ -0,0 +1,11 @@ +====================== + :mod:`mantid.kernel` +====================== + +.. module:: mantid.kernel + +.. toctree:: + :glob: + :maxdepth: 1 + + * diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_set_int.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_set_int.rst new file mode 100644 index 000000000000..f684db478e49 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_set_int.rst @@ -0,0 +1,14 @@ +============= + std_set_int +============= + +This a python binding to the C++ class Mantid::Kernel::std_set_int. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_set_int + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_set_str.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_set_str.rst new file mode 100644 index 000000000000..515f8b1cb98c --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_set_str.rst @@ -0,0 +1,14 @@ +============= + std_set_str +============= + +This a python binding to the C++ class Mantid::Kernel::std_set_str. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_set_str + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_InstrumentInfo.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_InstrumentInfo.rst new file mode 100644 index 000000000000..78493f29c9f2 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_InstrumentInfo.rst @@ -0,0 +1,14 @@ +=========================== + std_vector_InstrumentInfo +=========================== + +This a python binding to the C++ class Mantid::Kernel::std_vector_InstrumentInfo. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_InstrumentInfo + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_bool.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_bool.rst new file mode 100644 index 000000000000..0d73bc46a167 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_bool.rst @@ -0,0 +1,14 @@ +================= + std_vector_bool +================= + +This a python binding to the C++ class Mantid::Kernel::std_vector_bool. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_bool + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_dateandtime.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_dateandtime.rst new file mode 100644 index 000000000000..f9dbfe5195fa --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_dateandtime.rst @@ -0,0 +1,14 @@ +======================== + std_vector_dateandtime +======================== + +This a python binding to the C++ class Mantid::Kernel::std_vector_dateandtime. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_dateandtime + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_dbl.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_dbl.rst new file mode 100644 index 000000000000..0e03ad5e9177 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_dbl.rst @@ -0,0 +1,14 @@ +================ + std_vector_dbl +================ + +This a python binding to the C++ class Mantid::Kernel::std_vector_dbl. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_dbl + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_facilityinfo.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_facilityinfo.rst new file mode 100644 index 000000000000..008213df2a01 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_facilityinfo.rst @@ -0,0 +1,14 @@ +========================= + std_vector_facilityinfo +========================= + +This a python binding to the C++ class Mantid::Kernel::std_vector_facilityinfo. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_facilityinfo + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_int.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_int.rst new file mode 100644 index 000000000000..bb254dd593cd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_int.rst @@ -0,0 +1,14 @@ +================ + std_vector_int +================ + +This a python binding to the C++ class Mantid::Kernel::std_vector_int. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_int + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_long.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_long.rst new file mode 100644 index 000000000000..974e3ba8b2d0 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_long.rst @@ -0,0 +1,14 @@ +================= + std_vector_long +================= + +This a python binding to the C++ class Mantid::Kernel::std_vector_long. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_long + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_property.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_property.rst new file mode 100644 index 000000000000..38d6a42f70e0 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_property.rst @@ -0,0 +1,14 @@ +===================== + std_vector_property +===================== + +This a python binding to the C++ class Mantid::Kernel::std_vector_property. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_property + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_size_t.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_size_t.rst new file mode 100644 index 000000000000..1120745b1397 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_size_t.rst @@ -0,0 +1,14 @@ +=================== + std_vector_size_t +=================== + +This a python binding to the C++ class Mantid::Kernel::std_vector_size_t. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_size_t + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_str.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_str.rst new file mode 100644 index 000000000000..2099818f3b81 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/std_vector_str.rst @@ -0,0 +1,14 @@ +================ + std_vector_str +================ + +This a python binding to the C++ class Mantid::Kernel::std_vector_str. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.std_vector_str + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantid/kernel/time_duration.rst b/Code/Mantid/docs/source/api/python/mantid/kernel/time_duration.rst new file mode 100644 index 000000000000..08259563805c --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantid/kernel/time_duration.rst @@ -0,0 +1,14 @@ +=============== + time_duration +=============== + +This a python binding to the C++ class Mantid::Kernel::time_duration. + + +.. module:`mantid.kernel` + +.. autoclass:: mantid.kernel.time_duration + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/ArrowMarker.rst b/Code/Mantid/docs/source/api/python/mantidplot/ArrowMarker.rst new file mode 100644 index 000000000000..62b001688084 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/ArrowMarker.rst @@ -0,0 +1,14 @@ +============= + ArrowMarker +============= + +This a python binding to the C++ class Mantidplot::ArrowMarker. + + +.. module:`mantidplot` + +.. autoclass:: mantidplot.ArrowMarker + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/GraphOptions.rst b/Code/Mantid/docs/source/api/python/mantidplot/GraphOptions.rst new file mode 100644 index 000000000000..88f485d00674 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/GraphOptions.rst @@ -0,0 +1,14 @@ +============== + GraphOptions +============== + +This a python binding to the C++ class Mantidplot::GraphOptions. + + +.. module:`mantidplot` + +.. autoclass:: mantidplot.GraphOptions + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/ImageMarker.rst b/Code/Mantid/docs/source/api/python/mantidplot/ImageMarker.rst new file mode 100644 index 000000000000..663549ce86fe --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/ImageMarker.rst @@ -0,0 +1,14 @@ +============= + ImageMarker +============= + +This a python binding to the C++ class Mantidplot::ImageMarker. + + +.. module:`mantidplot` + +.. autoclass:: mantidplot.ImageMarker + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/ImageSymbol.rst b/Code/Mantid/docs/source/api/python/mantidplot/ImageSymbol.rst new file mode 100644 index 000000000000..7cb94e5a03a4 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/ImageSymbol.rst @@ -0,0 +1,15 @@ +============= + ImageSymbol +============= + +This a python binding to the C++ class Mantidplot::ImageSymbol. + +*bases:* :py:obj:`mantidplot.PlotSymbol` + +.. module:`mantidplot` + +.. autoclass:: mantidplot.ImageSymbol + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/InstrumentWindow.rst b/Code/Mantid/docs/source/api/python/mantidplot/InstrumentWindow.rst new file mode 100644 index 000000000000..bd6328197091 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/InstrumentWindow.rst @@ -0,0 +1,15 @@ +================== + InstrumentWindow +================== + +This a python binding to the C++ class Mantidplot::InstrumentWindow. + +*bases:* :py:obj:`mantidplot.MDIWindow` + +.. module:`mantidplot` + +.. autoclass:: mantidplot.InstrumentWindow + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/InstrumentWindowMaskTab.rst b/Code/Mantid/docs/source/api/python/mantidplot/InstrumentWindowMaskTab.rst new file mode 100644 index 000000000000..08a9147a05de --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/InstrumentWindowMaskTab.rst @@ -0,0 +1,15 @@ +========================= + InstrumentWindowMaskTab +========================= + +This a python binding to the C++ class Mantidplot::InstrumentWindowMaskTab. + +*bases:* :py:obj:`mantidplot.InstrumentWindowTab` + +.. module:`mantidplot` + +.. autoclass:: mantidplot.InstrumentWindowMaskTab + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/InstrumentWindowPickTab.rst b/Code/Mantid/docs/source/api/python/mantidplot/InstrumentWindowPickTab.rst new file mode 100644 index 000000000000..53c882982bbb --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/InstrumentWindowPickTab.rst @@ -0,0 +1,15 @@ +========================= + InstrumentWindowPickTab +========================= + +This a python binding to the C++ class Mantidplot::InstrumentWindowPickTab. + +*bases:* :py:obj:`mantidplot.InstrumentWindowTab` + +.. module:`mantidplot` + +.. autoclass:: mantidplot.InstrumentWindowPickTab + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/Layer.rst b/Code/Mantid/docs/source/api/python/mantidplot/Layer.rst new file mode 100644 index 000000000000..29ed514d3f75 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/Layer.rst @@ -0,0 +1,14 @@ +======= + Layer +======= + +This a python binding to the C++ class Mantidplot::Layer. + + +.. module:`mantidplot` + +.. autoclass:: mantidplot.Layer + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/PlotSymbol.rst b/Code/Mantid/docs/source/api/python/mantidplot/PlotSymbol.rst new file mode 100644 index 000000000000..9b5bd04ab3c5 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/PlotSymbol.rst @@ -0,0 +1,14 @@ +============ + PlotSymbol +============ + +This a python binding to the C++ class Mantidplot::PlotSymbol. + + +.. module:`mantidplot` + +.. autoclass:: mantidplot.PlotSymbol + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/Qt.rst b/Code/Mantid/docs/source/api/python/mantidplot/Qt.rst new file mode 100644 index 000000000000..9a6b17b6ed1a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/Qt.rst @@ -0,0 +1,14 @@ +==== + Qt +==== + +This a python binding to the C++ class PyQt4::QtCore::Qt. + + +.. module:`PyQt4.QtCore` + +.. autoclass:: PyQt4.QtCore.Qt + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/Screenshot.rst b/Code/Mantid/docs/source/api/python/mantidplot/Screenshot.rst new file mode 100644 index 000000000000..3863cc4bf7ba --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/Screenshot.rst @@ -0,0 +1,14 @@ +============ + Screenshot +============ + +This a python binding to the C++ class Mantidplot::Screenshot. + + +.. module:`mantidplot` + +.. autoclass:: mantidplot.Screenshot + :members: + :undoc-members: + :inherited-members: + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/activeFolder.rst b/Code/Mantid/docs/source/api/python/mantidplot/activeFolder.rst new file mode 100644 index 000000000000..26d0d87e8450 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/activeFolder.rst @@ -0,0 +1,8 @@ +============== + activeFolder +============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.activeFolder + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/addFolder.rst b/Code/Mantid/docs/source/api/python/mantidplot/addFolder.rst new file mode 100644 index 000000000000..321c5aa123b9 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/addFolder.rst @@ -0,0 +1,8 @@ +=========== + addFolder +=========== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.addFolder + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/changeFolder.rst b/Code/Mantid/docs/source/api/python/mantidplot/changeFolder.rst new file mode 100644 index 000000000000..0d12f36722f0 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/changeFolder.rst @@ -0,0 +1,8 @@ +============== + changeFolder +============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.changeFolder + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/clone.rst b/Code/Mantid/docs/source/api/python/mantidplot/clone.rst new file mode 100644 index 000000000000..e3594185e3d3 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/clone.rst @@ -0,0 +1,8 @@ +======= + clone +======= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.clone + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/closeAllSliceViewers.rst b/Code/Mantid/docs/source/api/python/mantidplot/closeAllSliceViewers.rst new file mode 100644 index 000000000000..a447cf9366be --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/closeAllSliceViewers.rst @@ -0,0 +1,8 @@ +====================== + closeAllSliceViewers +====================== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.closeAllSliceViewers + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/convertToWaterfall.rst b/Code/Mantid/docs/source/api/python/mantidplot/convertToWaterfall.rst new file mode 100644 index 000000000000..72a4d1e5ce3c --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/convertToWaterfall.rst @@ -0,0 +1,8 @@ +==================== + convertToWaterfall +==================== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.convertToWaterfall + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/copyFolder.rst b/Code/Mantid/docs/source/api/python/mantidplot/copyFolder.rst new file mode 100644 index 000000000000..2270df0da7eb --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/copyFolder.rst @@ -0,0 +1,8 @@ +============ + copyFolder +============ + +.. module:`mantidplot` + +.. autofunction:: mantidplot.copyFolder + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/createPropertyInputDialog.rst b/Code/Mantid/docs/source/api/python/mantidplot/createPropertyInputDialog.rst new file mode 100644 index 000000000000..ab64918f026c --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/createPropertyInputDialog.rst @@ -0,0 +1,8 @@ +=========================== + createPropertyInputDialog +=========================== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.createPropertyInputDialog + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/deleteFolder.rst b/Code/Mantid/docs/source/api/python/mantidplot/deleteFolder.rst new file mode 100644 index 000000000000..cd004dcd0ddd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/deleteFolder.rst @@ -0,0 +1,8 @@ +============== + deleteFolder +============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.deleteFolder + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/disableTools.rst b/Code/Mantid/docs/source/api/python/mantidplot/disableTools.rst new file mode 100644 index 000000000000..25eeaed5d904 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/disableTools.rst @@ -0,0 +1,8 @@ +============== + disableTools +============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.disableTools + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/fitBrowser.rst b/Code/Mantid/docs/source/api/python/mantidplot/fitBrowser.rst new file mode 100644 index 000000000000..da1bf0afbdab --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/fitBrowser.rst @@ -0,0 +1,8 @@ +============ + fitBrowser +============ + +.. module:`mantidplot` + +.. autofunction:: mantidplot.fitBrowser + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/getInstrumentView.rst b/Code/Mantid/docs/source/api/python/mantidplot/getInstrumentView.rst new file mode 100644 index 000000000000..4f6d81909805 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/getInstrumentView.rst @@ -0,0 +1,8 @@ +=================== + getInstrumentView +=================== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.getInstrumentView + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/getMantidMatrix.rst b/Code/Mantid/docs/source/api/python/mantidplot/getMantidMatrix.rst new file mode 100644 index 000000000000..f20c71fdfc4b --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/getMantidMatrix.rst @@ -0,0 +1,8 @@ +================= + getMantidMatrix +================= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.getMantidMatrix + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/getSliceViewer.rst b/Code/Mantid/docs/source/api/python/mantidplot/getSliceViewer.rst new file mode 100644 index 000000000000..f39c2e8fc7eb --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/getSliceViewer.rst @@ -0,0 +1,8 @@ +================ + getSliceViewer +================ + +.. module:`mantidplot` + +.. autofunction:: mantidplot.getSliceViewer + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/getWorkspaceNames.rst b/Code/Mantid/docs/source/api/python/mantidplot/getWorkspaceNames.rst new file mode 100644 index 000000000000..bddee073056e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/getWorkspaceNames.rst @@ -0,0 +1,8 @@ +=================== + getWorkspaceNames +=================== + +.. module:`mantidplotpy.proxies` + +.. autofunction:: mantidplotpy.proxies.getWorkspaceNames + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/get_screenshot_dir.rst b/Code/Mantid/docs/source/api/python/mantidplot/get_screenshot_dir.rst new file mode 100644 index 000000000000..79580740097d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/get_screenshot_dir.rst @@ -0,0 +1,8 @@ +==================== + get_screenshot_dir +==================== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.get_screenshot_dir + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/graph.rst b/Code/Mantid/docs/source/api/python/mantidplot/graph.rst new file mode 100644 index 000000000000..13f7d4560acb --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/graph.rst @@ -0,0 +1,8 @@ +======= + graph +======= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.graph + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/importImage.rst b/Code/Mantid/docs/source/api/python/mantidplot/importImage.rst new file mode 100644 index 000000000000..f5f29d443711 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/importImage.rst @@ -0,0 +1,8 @@ +============= + importImage +============= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.importImage + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/importMatrixWorkspace.rst b/Code/Mantid/docs/source/api/python/mantidplot/importMatrixWorkspace.rst new file mode 100644 index 000000000000..6ac811ccff60 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/importMatrixWorkspace.rst @@ -0,0 +1,8 @@ +======================= + importMatrixWorkspace +======================= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.importMatrixWorkspace + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/importTableWorkspace.rst b/Code/Mantid/docs/source/api/python/mantidplot/importTableWorkspace.rst new file mode 100644 index 000000000000..8e1dc61c032e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/importTableWorkspace.rst @@ -0,0 +1,8 @@ +====================== + importTableWorkspace +====================== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.importTableWorkspace + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/index.rst b/Code/Mantid/docs/source/api/python/mantidplot/index.rst new file mode 100644 index 000000000000..f5069356f01f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/index.rst @@ -0,0 +1,77 @@ +======================================== + :mod:`mantidplot` --- Plotting package +======================================== + +.. module:: mantidplot + +This package defines the Python interface to the MantidPlot application. For framework see :py:mod:`mantid`. + +.. toctree:: + + ArrowMarker.rst + GraphOptions.rst + ImageMarker.rst + ImageSymbol.rst + InstrumentWindow.rst + InstrumentWindowMaskTab.rst + InstrumentWindowPickTab.rst + Layer.rst + PlotSymbol.rst + Qt.rst + Screenshot.rst + activeFolder.rst + addFolder.rst + changeFolder.rst + clone.rst + closeAllSliceViewers.rst + convertToWaterfall.rst + copyFolder.rst + createPropertyInputDialog.rst + deleteFolder.rst + disableTools.rst + fitBrowser.rst + getInstrumentView.rst + getMantidMatrix.rst + getSliceViewer.rst + getWorkspaceNames.rst + get_screenshot_dir.rst + graph.rst + threadsafe_call.rst + importImage.rst + importMatrixWorkspace.rst + importTableWorkspace.rst + matrix.rst + matrixToTable.rst + mergePlots.rst + newGraph.rst + newMatrix.rst + newNote.rst + newPlot3D.rst + newTable.rst + new_proxy.rst + note.rst + openTemplate.rst + plot.rst + plot2D.rst + plot3D.rst + plotBin.rst + plotMD.rst + plotSlice.rst + plotSpectrum.rst + plotBin.rst + rootFolder.rst + runPythonScript.rst + saveAsTemplate.rst + screenshot.rst + screenshot_to_dir.rst + selectMultiPeak.rst + setPreferences.rst + setToolbarsVisible.rst + setWindowName.rst + stemPlot.rst + table.rst + tableToMatrix.rst + threadsafe_call.rst + waterfallPlot.rst + windows.rst + workspace.rst diff --git a/Code/Mantid/docs/source/api/python/mantidplot/matrix.rst b/Code/Mantid/docs/source/api/python/mantidplot/matrix.rst new file mode 100644 index 000000000000..99d1b240b3a5 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/matrix.rst @@ -0,0 +1,8 @@ +======== + matrix +======== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.matrix + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/matrixToTable.rst b/Code/Mantid/docs/source/api/python/mantidplot/matrixToTable.rst new file mode 100644 index 000000000000..13375fbf2a7d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/matrixToTable.rst @@ -0,0 +1,8 @@ +=============== + matrixToTable +=============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.matrixToTable + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/mergePlots.rst b/Code/Mantid/docs/source/api/python/mantidplot/mergePlots.rst new file mode 100644 index 000000000000..965ecc5e267e --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/mergePlots.rst @@ -0,0 +1,8 @@ +============ + mergePlots +============ + +.. module:`mantidplot` + +.. autofunction:: mantidplot.mergePlots + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/newGraph.rst b/Code/Mantid/docs/source/api/python/mantidplot/newGraph.rst new file mode 100644 index 000000000000..e8d6e2c73240 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/newGraph.rst @@ -0,0 +1,8 @@ +========== + newGraph +========== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.newGraph + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/newMatrix.rst b/Code/Mantid/docs/source/api/python/mantidplot/newMatrix.rst new file mode 100644 index 000000000000..48dd85ad5778 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/newMatrix.rst @@ -0,0 +1,8 @@ +=========== + newMatrix +=========== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.newMatrix + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/newNote.rst b/Code/Mantid/docs/source/api/python/mantidplot/newNote.rst new file mode 100644 index 000000000000..c85fc446158d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/newNote.rst @@ -0,0 +1,8 @@ +========= + newNote +========= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.newNote + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/newPlot3D.rst b/Code/Mantid/docs/source/api/python/mantidplot/newPlot3D.rst new file mode 100644 index 000000000000..7451d2f99fa8 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/newPlot3D.rst @@ -0,0 +1,8 @@ +=========== + newPlot3D +=========== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.newPlot3D + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/newTable.rst b/Code/Mantid/docs/source/api/python/mantidplot/newTable.rst new file mode 100644 index 000000000000..a237c0d517b4 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/newTable.rst @@ -0,0 +1,8 @@ +========== + newTable +========== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.newTable + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/new_proxy.rst b/Code/Mantid/docs/source/api/python/mantidplot/new_proxy.rst new file mode 100644 index 000000000000..bde3aa3f882b --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/new_proxy.rst @@ -0,0 +1,8 @@ +=========== + new_proxy +=========== + +.. module:`mantidplotpy.proxies` + +.. autofunction:: mantidplotpy.proxies.new_proxy + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/note.rst b/Code/Mantid/docs/source/api/python/mantidplot/note.rst new file mode 100644 index 000000000000..53885d74f6dd --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/note.rst @@ -0,0 +1,8 @@ +====== + note +====== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.note + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/openTemplate.rst b/Code/Mantid/docs/source/api/python/mantidplot/openTemplate.rst new file mode 100644 index 000000000000..74034be22214 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/openTemplate.rst @@ -0,0 +1,8 @@ +============== + openTemplate +============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.openTemplate + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/plot.rst b/Code/Mantid/docs/source/api/python/mantidplot/plot.rst new file mode 100644 index 000000000000..bd58de32ef17 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/plot.rst @@ -0,0 +1,8 @@ +====== + plot +====== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.plot + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/plot2D.rst b/Code/Mantid/docs/source/api/python/mantidplot/plot2D.rst new file mode 100644 index 000000000000..86c7c5538bc7 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/plot2D.rst @@ -0,0 +1,8 @@ +======== + plot2D +======== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.plot2D + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/plot3D.rst b/Code/Mantid/docs/source/api/python/mantidplot/plot3D.rst new file mode 100644 index 000000000000..99160f05eb8c --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/plot3D.rst @@ -0,0 +1,8 @@ +======== + plot3D +======== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.plot3D + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/plotBin.rst b/Code/Mantid/docs/source/api/python/mantidplot/plotBin.rst new file mode 100644 index 000000000000..aa504589db36 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/plotBin.rst @@ -0,0 +1,8 @@ +========= + plotBin +========= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.plotBin + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/plotMD.rst b/Code/Mantid/docs/source/api/python/mantidplot/plotMD.rst new file mode 100644 index 000000000000..0bfd5b74712d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/plotMD.rst @@ -0,0 +1,8 @@ +======== + plotMD +======== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.plotMD + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/plotSlice.rst b/Code/Mantid/docs/source/api/python/mantidplot/plotSlice.rst new file mode 100644 index 000000000000..42ad4bdcd8e8 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/plotSlice.rst @@ -0,0 +1,8 @@ +=========== + plotSlice +=========== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.plotSlice + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/plotSpectrum.rst b/Code/Mantid/docs/source/api/python/mantidplot/plotSpectrum.rst new file mode 100644 index 000000000000..5e7a80c48c18 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/plotSpectrum.rst @@ -0,0 +1,8 @@ +============== + plotSpectrum +============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.plotSpectrum + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/rootFolder.rst b/Code/Mantid/docs/source/api/python/mantidplot/rootFolder.rst new file mode 100644 index 000000000000..703d7e0e4a25 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/rootFolder.rst @@ -0,0 +1,8 @@ +============ + rootFolder +============ + +.. module:`mantidplot` + +.. autofunction:: mantidplot.rootFolder + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/runPythonScript.rst b/Code/Mantid/docs/source/api/python/mantidplot/runPythonScript.rst new file mode 100644 index 000000000000..787bda6cbfc3 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/runPythonScript.rst @@ -0,0 +1,8 @@ +================= + runPythonScript +================= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.runPythonScript + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/saveAsTemplate.rst b/Code/Mantid/docs/source/api/python/mantidplot/saveAsTemplate.rst new file mode 100644 index 000000000000..f5350e3ffa82 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/saveAsTemplate.rst @@ -0,0 +1,8 @@ +================ + saveAsTemplate +================ + +.. module:`mantidplot` + +.. autofunction:: mantidplot.saveAsTemplate + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/screenshot.rst b/Code/Mantid/docs/source/api/python/mantidplot/screenshot.rst new file mode 100644 index 000000000000..a2f1913847d8 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/screenshot.rst @@ -0,0 +1,8 @@ +============ + screenshot +============ + +.. module:`mantidplot` + +.. autofunction:: mantidplot.screenshot + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/screenshot_to_dir.rst b/Code/Mantid/docs/source/api/python/mantidplot/screenshot_to_dir.rst new file mode 100644 index 000000000000..88aa6a0c82b8 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/screenshot_to_dir.rst @@ -0,0 +1,8 @@ +=================== + screenshot_to_dir +=================== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.screenshot_to_dir + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/selectMultiPeak.rst b/Code/Mantid/docs/source/api/python/mantidplot/selectMultiPeak.rst new file mode 100644 index 000000000000..e3615a67862d --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/selectMultiPeak.rst @@ -0,0 +1,8 @@ +================= + selectMultiPeak +================= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.selectMultiPeak + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/setPreferences.rst b/Code/Mantid/docs/source/api/python/mantidplot/setPreferences.rst new file mode 100644 index 000000000000..a194146d95b6 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/setPreferences.rst @@ -0,0 +1,8 @@ +================ + setPreferences +================ + +.. module:`mantidplot` + +.. autofunction:: mantidplot.setPreferences + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/setToolbarsVisible.rst b/Code/Mantid/docs/source/api/python/mantidplot/setToolbarsVisible.rst new file mode 100644 index 000000000000..16657a7974bc --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/setToolbarsVisible.rst @@ -0,0 +1,8 @@ +==================== + setToolbarsVisible +==================== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.setToolbarsVisible + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/setWindowName.rst b/Code/Mantid/docs/source/api/python/mantidplot/setWindowName.rst new file mode 100644 index 000000000000..ac91970cc9ac --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/setWindowName.rst @@ -0,0 +1,8 @@ +=============== + setWindowName +=============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.setWindowName + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/stemPlot.rst b/Code/Mantid/docs/source/api/python/mantidplot/stemPlot.rst new file mode 100644 index 000000000000..aa9ac70a5579 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/stemPlot.rst @@ -0,0 +1,8 @@ +========== + stemPlot +========== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.stemPlot + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/table.rst b/Code/Mantid/docs/source/api/python/mantidplot/table.rst new file mode 100644 index 000000000000..241fd21dc876 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/table.rst @@ -0,0 +1,8 @@ +======= + table +======= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.table + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/tableToMatrix.rst b/Code/Mantid/docs/source/api/python/mantidplot/tableToMatrix.rst new file mode 100644 index 000000000000..a0638134928a --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/tableToMatrix.rst @@ -0,0 +1,8 @@ +=============== + tableToMatrix +=============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.tableToMatrix + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/threadsafe_call.rst b/Code/Mantid/docs/source/api/python/mantidplot/threadsafe_call.rst new file mode 100644 index 000000000000..c76ff1528ff6 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/threadsafe_call.rst @@ -0,0 +1,8 @@ +================= + threadsafe_call +================= + +.. module:`mantidplotpy.proxies` + +.. autofunction:: mantidplotpy.proxies.threadsafe_call + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/waterfallPlot.rst b/Code/Mantid/docs/source/api/python/mantidplot/waterfallPlot.rst new file mode 100644 index 000000000000..338ff6ce076f --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/waterfallPlot.rst @@ -0,0 +1,8 @@ +=============== + waterfallPlot +=============== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.waterfallPlot + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/windows.rst b/Code/Mantid/docs/source/api/python/mantidplot/windows.rst new file mode 100644 index 000000000000..7c39901f64b1 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/windows.rst @@ -0,0 +1,8 @@ +========= + windows +========= + +.. module:`mantidplot` + +.. autofunction:: mantidplot.windows + diff --git a/Code/Mantid/docs/source/api/python/mantidplot/workspace.rst b/Code/Mantid/docs/source/api/python/mantidplot/workspace.rst new file mode 100644 index 000000000000..84bf5b0be609 --- /dev/null +++ b/Code/Mantid/docs/source/api/python/mantidplot/workspace.rst @@ -0,0 +1,8 @@ +=========== + workspace +=========== + +.. module:`mantidplot` + +.. autofunction:: mantidplot.workspace +