Add calibration pages from the old sphinx docs.

Refs #9624
mantidproject · Jun 11, 2014 · 9ab5d34 · 9ab5d34
1 parent db561c5
commit 9ab5d34
Show file tree

Hide file tree

Showing 10 changed files with 52 additions and 1 deletion.
diff --git a/Code/Mantid/docs/source/api/python/index.rst b/Code/Mantid/docs/source/api/python/index.rst
@@ -12,4 +12,12 @@ Reference
    :maxdepth: 1
 
    mantid <mantid/index>
-   mantidplot <mantidplot/index>
+   mantidplot <mantidplot/index>
+
+Techniques
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   techniques/calibration
diff --git a/Code/Mantid/docs/source/api/python/techniques/calibration.rst b/Code/Mantid/docs/source/api/python/techniques/calibration.rst
@@ -0,0 +1,18 @@
+=============
+ Calibration
+=============
+
+Calibration is currently based on tubes and is accessed using the :mod:`tube` module.
+
+.. automodule:: tube
+
+Implementation
+--------------
+
+More details on the finer points of the calibration implementation can be found at http://www.mantidproject.org/Tube_Calibration and
+in:
+
+.. toctree::
+   :maxdepth: 1
+
+   calibration_implementation
diff --git a/Code/Mantid/docs/source/api/python/techniques/calibration_implementation.rst b/Code/Mantid/docs/source/api/python/techniques/calibration_implementation.rst
@@ -0,0 +1,25 @@
+====================================
+ Calibration Implementation Details
+====================================
+
+.. automodule:: tube_calib
+   :members:
+
+TubeSpec
+------------------
+
+.. autoclass:: tube_spec.TubeSpec
+   :members:                
+
+TubeCalibFitParams
+------------------
+
+.. autoclass:: tube_calib_fit_params.TubeCalibFitParams
+   :members:              
+
+
+IdealTube
+---------
+
+.. autoclass:: ideal_tube.IdealTube
+   :members:              
diff --git a/Code/Mantid/docs/source/images/calibrateB2Window.png b/Code/Mantid/docs/source/images/calibrateB2Window.png
diff --git a/Code/Mantid/docs/source/images/calibrateChangeMarginAndExpectedValue.png b/Code/Mantid/docs/source/images/calibrateChangeMarginAndExpectedValue.png
diff --git a/Code/Mantid/docs/source/images/calibratePlotFittedData.png b/Code/Mantid/docs/source/images/calibratePlotFittedData.png
diff --git a/Code/Mantid/docs/source/images/calibratedCurrentMerlin.png b/Code/Mantid/docs/source/images/calibratedCurrentMerlin.png
diff --git a/Code/Mantid/docs/source/images/calibratedMantidMerlin.png b/Code/Mantid/docs/source/images/calibratedMantidMerlin.png
diff --git a/Code/Mantid/docs/source/images/outputOfMinimalInput.png b/Code/Mantid/docs/source/images/outputOfMinimalInput.png
diff --git a/Code/Mantid/docs/source/images/plotingPeaksDifference.png b/Code/Mantid/docs/source/images/plotingPeaksDifference.png