From fcc70ab9391ba66648bda8dab456579700b51b13 Mon Sep 17 00:00:00 2001
From: Andrei Savici <saviciat@ornl.gov>
Date: Thu, 5 Oct 2017 20:07:36 -0400
Subject: [PATCH] Fix some sphinx/ formating issues
---
docs/source/algorithms/FindSXPeaks-v1.rst | 8 ++++----
docs/source/fitfunctions/MsdGauss.rst | 8 +++++---
docs/source/fitfunctions/MsdPeters.rst | 8 ++++----
docs/source/fitfunctions/MsdYi.rst | 8 ++++----
.../release/v3.11.0/indirect_inelastic.rst | 2 +-
docs/source/release/v3.11.0/ui.rst | 18 +++++++++---------
6 files changed, 27 insertions(+), 25 deletions(-)
diff --git a/docs/source/algorithms/FindSXPeaks-v1.rst b/docs/source/algorithms/FindSXPeaks-v1.rst
index 811893a826f..fac418cb7b7 100644
--- a/docs/source/algorithms/FindSXPeaks-v1.rst
+++ b/docs/source/algorithms/FindSXPeaks-v1.rst
@@ -28,8 +28,8 @@ Strongest peak mode:
:math:`\phi`, :math:`2\theta`, and :math:`t` of two found peaks. If the
absolute difference between any of the parameters for two peaks is greater
than the product of the tolerance value and the parameter value then the two
- peaks are classed as not the same. i.e. if :math:`|\phi_1 - \phi_2| >
- tolerance * \phi_1` then peaks 1 & 2 are not the same (as well as similar
+ peaks are classed as not the same. i.e. if :math:`|\phi_1 - \phi_2| > tolerance * \phi_1`
+ then peaks 1 & 2 are not the same (as well as similar
definitions for :math:`2\theta` and :math:`t`).
@@ -51,8 +51,8 @@ All peaks mode:
difference between the parameters :math:`\phi`, :math:`2\theta`, and
:math:`t` of two found peaks. If the absolute difference between any of the
parameters for two peaks is greater than the absolute tolerance then the two
- peaks are classed as not the same. i.e. if :math:`|\phi_1 - \phi_2| >
- PhiTolerance then peaks 1 & 2 are not the same (as well as similar
+ peaks are classed as not the same. i.e. if :math:`|\phi_1 - \phi_2| > PhiTolerance`
+ then peaks 1 & 2 are not the same (as well as similar
definitions for :math:`2\theta` and :math:`t`).
diff --git a/docs/source/fitfunctions/MsdGauss.rst b/docs/source/fitfunctions/MsdGauss.rst
index 99b0fb2a382..01561d4caef 100644
--- a/docs/source/fitfunctions/MsdGauss.rst
+++ b/docs/source/fitfunctions/MsdGauss.rst
@@ -11,11 +11,13 @@ Description
The Gaussian model for Mean-squared displacement fitting is defined as:
-.. math:: \mbox{Height}e^{-MSD x^2}
+.. math::
+
+ \mbox{Height}\cdot e^{-MSD\cdot x^2}
where:
-- .. math:: `MSD` is the mean squared displacement
-- .. math:: `Height` is the intensity scaling
+ - :math:`MSD` is the mean squared displacement
+ - :math:`Height` is the intensity scaling
.. attributes::
diff --git a/docs/source/fitfunctions/MsdPeters.rst b/docs/source/fitfunctions/MsdPeters.rst
index 35f8c4c4759..0868b4f240d 100644
--- a/docs/source/fitfunctions/MsdPeters.rst
+++ b/docs/source/fitfunctions/MsdPeters.rst
@@ -13,12 +13,12 @@ The Peters model for Mean-squared displacement fitting is defined as:
.. math::
- \frac{Height}{\power{1 + \frac{MSD x^2}{6 \beta}}{\beta}}
+ \frac{Height}{\left(1 + \frac{MSD\cdot x^2}{6 \beta}\right)^\beta}
where:
-- .. math::`MSD` is the mean-squared displacement
-- .. math::`\beta` is the inverse scale/rate parameter
-- .. math::`Height` is the intensity scaling
+ - :math:`MSD` is the mean-squared displacement
+ - :math:`\beta` is the inverse scale/rate parameter
+ - :math:`Height` is the intensity scaling
.. attributes::
diff --git a/docs/source/fitfunctions/MsdYi.rst b/docs/source/fitfunctions/MsdYi.rst
index b42be04eb70..7a0b5023573 100644
--- a/docs/source/fitfunctions/MsdYi.rst
+++ b/docs/source/fitfunctions/MsdYi.rst
@@ -13,12 +13,12 @@ The Yi model for Mean-squared displacement fitting is defined as:
.. math::
- Height \exp(\frac{-1}{6 x^2 MSD}) (1 + \frac{x^4 * \sigma}{72})
+ Height \exp\left(\frac{-1}{6 x^2 MSD}\right) \left(1 + \frac{x^4 * \sigma}{72}\right)
where:
-- .. math::`MSD` is the mean squared displacement
-- .. math::`Sigma` is the standard deviation
-- .. math::`Height` is the intensity scaling
+ - :math:`MSD` is the mean squared displacement
+ - :math:`Sigma` is the standard deviation
+ - :math:`Height` is the intensity scaling
.. attributes::
diff --git a/docs/source/release/v3.11.0/indirect_inelastic.rst b/docs/source/release/v3.11.0/indirect_inelastic.rst
index b622b5a9efa..e764bcc8cf3 100644
--- a/docs/source/release/v3.11.0/indirect_inelastic.rst
+++ b/docs/source/release/v3.11.0/indirect_inelastic.rst
@@ -16,7 +16,7 @@ New
Improved
########
- The following changes were made to the :ref:`algm-MSDFit` algorithm:
- - Added model selection to the :ref:`algm-MSDFit` algorithm, with three current models: MsdPeters, MsdYi and MsdPeters. New models now work with workspaces in Q not Q^2 (e.g. _eq workspaces 'Elastic Q').
+ - Added model selection to the :ref:`algm-MSDFit` algorithm, with three current models: :ref:`MsdGauss <func-MsdGauss>`, :ref:`MsdYi <func-MsdYi>`, and :ref:`MsdYi <func-MsdYi>`. New models now work with workspaces in :math:`Q` not :math:`Q^2` (e.g. _eq workspaces 'Elastic Q').
- The following changes were made to the the :ref:`algm-ConvolutionFitSequential` algorithm:
- Added 'ExtractMembers' property to :ref:`algm-ConvolutionFitSequential` - this allows for extracting the members of the convolution fitting into their own workspaces.
- Property to pass the workspace index added to :ref:`algm-ConvolutionFitSequential`.
diff --git a/docs/source/release/v3.11.0/ui.rst b/docs/source/release/v3.11.0/ui.rst
index 740bc61d7a2..b4f5905d015 100644
--- a/docs/source/release/v3.11.0/ui.rst
+++ b/docs/source/release/v3.11.0/ui.rst
@@ -9,7 +9,7 @@ UI & Usability Changes
User Interface
--------------
-- Fixed the ability to drag & drop files into Mantid OSX >=10.10
+- Fixed the ability to drag & drop files into Mantid on OSX >=10.10
- The welcome dialog has been redesigned to use less of the screen to fit better onto laptops with small high resolution screens that use screen scaling.
Scanning workspaces
@@ -50,17 +50,17 @@ VSI Improvements
- Upstream ParaView Contributions
- - Fix scaling, orientation and position inputs when nonorthogonal axes are present.
- - Speed up MultiSlice view by avoiding repeated allocating and freeing memory.
- - Fix the resample to image mapper, which was failing when input contains cell data.
- - Expose the SamplingDimensions property when using the resample to image mapper with vtkStructuredGrids.
+ - Fix scaling, orientation and position inputs when nonorthogonal axes are present.
+ - Speed up MultiSlice view by avoiding repeated allocating and freeing memory.
+ - Fix the resample to image mapper, which was failing when input contains cell data.
+ - Expose the SamplingDimensions property when using the resample to image mapper with vtkStructuredGrids.
- Upstream VTK Contributions
- - Improve surface filter performance using vtkSMPTools
- - Refactor the vtkDataSetTriangleFilter for better performance.
- - Refactor the threshold filter to take advantage of structured data.
- - Minimize duplicate code in vtkDataArrayPrivate and parallelize range calculation.
+ - Improve surface filter performance using vtkSMPTools
+ - Refactor the vtkDataSetTriangleFilter for better performance.
+ - Refactor the threshold filter to take advantage of structured data.
+ - Minimize duplicate code in vtkDataArrayPrivate and parallelize range calculation.
- Multislice view uses a custom `representation <https://www.paraview.org/ParaView/index.php/Views_And_Representations>`_ to speed up slicing by taking advantage of the consistent bin
sizes in a MDHistoWorkspace. Smooth interaction with typical data sizes (< 10 million cells) is now possible.
--
GitLab