Configure sphinx to parse the tube calibration

re #7437
mantidproject · Jul 15, 2013 · bce375a · bce375a
1 parent 7112a20
commit bce375a
Show file tree

Hide file tree

Showing 12 changed files with 48 additions and 1 deletion.
diff --git a/Code/Mantid/MantidPlot/docs/python/CMakeLists.txt b/Code/Mantid/MantidPlot/docs/python/CMakeLists.txt
@@ -25,13 +25,20 @@ if ( SPHINX_FOUND )
     source/index.rst
     source/changes.rst
     source/contents.rst
+    source/techiniques/calibration.rst
     source/api/mantid.rst
     source/api/mantidplot.rst
     source/_templates/indexcontent.html
     source/_templates/indexsidebar.html
     source/_templates/layout.html
+    source/images/calibrateB2Window.png
+    source/images/calibratedCurrentMerlin.png
+    source/images/calibratedMantidMerlin.png
+    source/images/calibrateExtendMarginAndExpectedValue.png
+    source/images/calibratePlotFittedData.png
+    source/images/outputOfMinimalInput.png
+    source/images/plotingPeaksDifference.png
   )
-
   # The destination for the copied files
   set ( SPHINX_CONF_DIR ${CMAKE_CURRENT_BINARY_DIR} )
   set ( SPHINX_CONF_FILES )

diff --git a/Code/Mantid/MantidPlot/docs/python/source/_templates/indexcontent.html b/Code/Mantid/MantidPlot/docs/python/source/_templates/indexcontent.html
@@ -21,6 +21,14 @@
     </td></tr>
   </table>
 
+  <p><strong>Scientific Techniques:</strong></p>
+  <table class="contentstable" align="center"><tr>
+    <td width="50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("techiniques/calibration") }}">Calibration</a><br/>
+         <span class="linkdescr">Scripts to perform Tubes calibration</span></p>
+    </td></tr>
+  </table>
+
   <p><strong>Indices and tables:</strong></p>
   <table class="contentstable" align="center"><tr>
     <td width="50%">

diff --git a/Code/Mantid/MantidPlot/docs/python/source/contents.rst b/Code/Mantid/MantidPlot/docs/python/source/contents.rst
@@ -7,3 +7,4 @@ Mantid Python References Contents
   changes
   api/mantid
   api/mantidplot
+  techiniques/calibration
diff --git a/Code/Mantid/MantidPlot/docs/python/source/images/calibrateB2Window.png b/Code/Mantid/MantidPlot/docs/python/source/images/calibrateB2Window.png
diff --git a/.../MantidPlot/docs/python/source/images/calibrateExtendMarginAndExpectedValue.png b/.../MantidPlot/docs/python/source/images/calibrateExtendMarginAndExpectedValue.png
diff --git a/Code/Mantid/MantidPlot/docs/python/source/images/calibratePlotFittedData.png b/Code/Mantid/MantidPlot/docs/python/source/images/calibratePlotFittedData.png
diff --git a/Code/Mantid/MantidPlot/docs/python/source/images/calibratedCurrentMerlin.png b/Code/Mantid/MantidPlot/docs/python/source/images/calibratedCurrentMerlin.png
diff --git a/Code/Mantid/MantidPlot/docs/python/source/images/calibratedMantidMerlin.png b/Code/Mantid/MantidPlot/docs/python/source/images/calibratedMantidMerlin.png
diff --git a/Code/Mantid/MantidPlot/docs/python/source/images/outputOfMinimalInput.png b/Code/Mantid/MantidPlot/docs/python/source/images/outputOfMinimalInput.png
diff --git a/Code/Mantid/MantidPlot/docs/python/source/images/plotingPeaksDifference.png b/Code/Mantid/MantidPlot/docs/python/source/images/plotingPeaksDifference.png
diff --git a/Code/Mantid/MantidPlot/docs/python/source/techiniques/calibration.rst b/Code/Mantid/MantidPlot/docs/python/source/techiniques/calibration.rst
@@ -0,0 +1,15 @@
+%%%%%%%%%%%
+Calibration
+%%%%%%%%%%%
+.. default-domain:: py
+
+
+.. sidebar:: Further documentation
+
+   .. _Wiki TubeCalibration: http://www.mantidproject.org/Tube_Calibration
+
+   Please, look at `Wiki TubeCalibration`_ for more documentation.
+
+.. automodule:: tube
+
+
diff --git a/Code/Mantid/scripts/Calibration/Examples/__init__.py b/Code/Mantid/scripts/Calibration/Examples/__init__.py
@@ -0,0 +1,16 @@
+"""
+
+MAPS instrument
+===============
+
+.. automodule:: Examples.TubeCalibDemoMaps_All
+
+
+
+MERLIN instrument
+=================
+
+.. automodule:: Examples.TubeCalibDemoMerlin
+
+
+"""