From 42db01a0ca4faab8761e6ab5c84a7caedc3f8959 Mon Sep 17 00:00:00 2001 From: Martyn Gigg Date: Wed, 25 Jun 2014 13:37:12 +0100 Subject: [PATCH] Fix more docs sphinx errors. Refs #9749 --- .../docs/source/algorithms/RadiusSum-v1.rst | 9 ------ .../ResizeRectangularDetector-v1.rst | 1 + .../source/algorithms/RetrieveRunInfo-v1.rst | 1 + .../algorithms/SaveGSASInstrumentFile-v1.rst | 10 +++---- .../docs/source/algorithms/SaveMask-v1.rst | 28 +++++++++---------- 5 files changed, 21 insertions(+), 28 deletions(-) diff --git a/Code/Mantid/docs/source/algorithms/RadiusSum-v1.rst b/Code/Mantid/docs/source/algorithms/RadiusSum-v1.rst index 737e72f74d45..9245a89e7a1f 100644 --- a/Code/Mantid/docs/source/algorithms/RadiusSum-v1.rst +++ b/Code/Mantid/docs/source/algorithms/RadiusSum-v1.rst @@ -16,16 +16,12 @@ Workspace2D where the position of the pixels are not associated to detector positions, but it is derived from the Axes. .. figure:: /images/ExecuteRadiusSum.png - :alt: 800px - 800px The image below shows a visual interpretation for the inputs of the algorithm .. figure:: /images/RadiusSumInputs.png - :alt: 300px - 300px The Algorithm create **NumBins** rings around the **Centre** point each one with :math:`width = BinSize` for :math:`BinSize=\frac{MaxRadius-MinRadius}{NumBins}`. @@ -38,16 +34,11 @@ below, shows what does this means. An ideal solution for RadiusSum is the left image, while the right image is what is current implemented. .. figure:: /images/RadiusSumSolutions.png - :alt: 300px - 300px Although the images were applied to an image `Workspace2D `_, the image below shows that it is possible to apply this algorithm to Workspaces attached to instruments. .. figure:: /images/RadiusSumInstrument.png - :alt: 800 px - - 800 px .. categories:: diff --git a/Code/Mantid/docs/source/algorithms/ResizeRectangularDetector-v1.rst b/Code/Mantid/docs/source/algorithms/ResizeRectangularDetector-v1.rst index 64c87ac20fe4..456bbfc064c9 100644 --- a/Code/Mantid/docs/source/algorithms/ResizeRectangularDetector-v1.rst +++ b/Code/Mantid/docs/source/algorithms/ResizeRectangularDetector-v1.rst @@ -52,6 +52,7 @@ Usage print ("bank 1 was scaled and is now %.2f by %.2f" % (bank1.xsize(), bank1.ysize())) print ("bank 2 was not scaled and remains %.2f by %.2f" % (bank2.xsize(), bank2.ysize())) + Output: .. testoutput:: ExScaleBank1 diff --git a/Code/Mantid/docs/source/algorithms/RetrieveRunInfo-v1.rst b/Code/Mantid/docs/source/algorithms/RetrieveRunInfo-v1.rst index 1e9a2a1e81b1..7e40b66034bb 100644 --- a/Code/Mantid/docs/source/algorithms/RetrieveRunInfo-v1.rst +++ b/Code/Mantid/docs/source/algorithms/RetrieveRunInfo-v1.rst @@ -22,6 +22,7 @@ result table. Output workspace generated by inspecting runs 12218-12229 and having the default instrument set to TOSCA. + Limitations ----------- diff --git a/Code/Mantid/docs/source/algorithms/SaveGSASInstrumentFile-v1.rst b/Code/Mantid/docs/source/algorithms/SaveGSASInstrumentFile-v1.rst index 53727556063a..15cea7377bd2 100644 --- a/Code/Mantid/docs/source/algorithms/SaveGSASInstrumentFile-v1.rst +++ b/Code/Mantid/docs/source/algorithms/SaveGSASInstrumentFile-v1.rst @@ -42,9 +42,9 @@ There are several places in this algorithm that can set the value of :math:`2\theta`. From the highest priority, here is the list how :math:`2\theta` is set up. -| ``1. Algorithms' input property "TwoTheta";`` -| ``2. Either input TableWorkspace or input Fullprof resolution (.irf) file;`` -| ``3. Hard coded default "TwoTheta" of a certain instrument.`` +1. Algorithms' input property ``TwoTheta``; +2. Either input TableWorkspace or input Fullprof resolution (.irf) file; +3. Hard coded default "TwoTheta" of a certain instrument. Set up :math:`L_1` ################## @@ -53,8 +53,8 @@ There are 2 places in this algorithm that can set the value of :math:`L_1`. From the highest priority, here is the list how :math:`2\theta` is set up. -| ``1. Algorithms' input property "L1"; `` -| ``2. Hard coded default "TwoTheta" of a certain instrument.`` +1. Algorithms' input property ``L1``; +2. Hard coded default "TwoTheta" of a certain instrument. Calculation of :math:`L_2` ########################## diff --git a/Code/Mantid/docs/source/algorithms/SaveMask-v1.rst b/Code/Mantid/docs/source/algorithms/SaveMask-v1.rst index 97ae11d1cae3..c398c9b829b5 100644 --- a/Code/Mantid/docs/source/algorithms/SaveMask-v1.rst +++ b/Code/Mantid/docs/source/algorithms/SaveMask-v1.rst @@ -18,13 +18,13 @@ file. This algorithm has previously been renamed from SaveDetectorMasks. There are two types of mask workspace that can serve as input. 1. `MaskWorkspace `__ -#################################### +################################################################## In this case, :ref:`algm-SaveMask` will read Y values to determine which detectors are masked; 2. A non-\ `MaskWorkspace `__ `MatrixWorkspace `__ containing `Instrument `__ -######################################################################################################################### +################################################################################################################################################################################################################ In this case, :ref:`algm-SaveMask` will scan through all detectors to determine which are masked. @@ -32,11 +32,11 @@ determine which are masked. Definition of Mask ------------------ -If a pixel is **masked**, it means that the data from this pixel won't be used. -In the masking workspace (i.e., `SpecialWorkspace2D `__), the corresponding value is 1.  +If a pixel is **masked**, it means that the data from this pixel won't be used. +In the masking workspace (i.e., `SpecialWorkspace2D `__), the corresponding value is 1. -If a pixel is **NOT masked**, it means that the data from this pixel will be used.  `` -In the masking workspace (i.e., `SpecialWorkspace2D `__), the corresponding value is 0. +If a pixel is **NOT masked**, it means that the data from this pixel will be used. `` +In the masking workspace (i.e., `SpecialWorkspace2D `__), the corresponding value is 0. XML File Format --------------- @@ -45,13 +45,13 @@ Example 1: .. code-block:: xml - - - - 3,34-44,47 - bank123 - bank124 - - + + + + 3,34-44,47 + bank123 + bank124 + + .. categories::