Fixing some documentation warnings

wdzhou · Feb 15, 2017 · a7eed4e · a7eed4e
1 parent 3d28fb6
commit a7eed4e
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 13 deletions.
diff --git a/MantidPlot/pymantidplot/__init__.py b/MantidPlot/pymantidplot/__init__.py
@@ -801,14 +801,13 @@ def plotSlice(source, label="", xydim=None, slicepoint=None,
 
     Optional Keyword Args:
         label :: label for the window title
-        xydim :: indexes or names of the dimensions to plot, as an (X,Y) list or tuple. See SliceViewer::setXYDim()
-        slicepoint :: list with the slice point in each dimension.
-                      Must be the same length as the number of dimensions of the workspace.
-                      See SliceViewer::setSlicePoint()
-        colormin :: value of the minimum color in the scale. See SliceViewer::setColorScaleMin()
-        colormax :: value of the maximum color in the scale. See SliceViewer::setColorScaleMax()
-        colorscalelog :: value of the maximum color in the scale. See SliceViewer::setColorScaleLog()
-        limits :: list with the (xleft, xright, ybottom, ytop) limits to the view to show. See SliceViewer::setXYLimits()
+        xydim :: indexes or names of the dimensions to plot, as an (X,Y) list or tuple. See `SliceViewer::setXYDim()`
+        slicepoint :: list with the slice point in each dimension.Must be the same length as the number of \
+dimensions of the workspace. See SliceViewer::setSlicePoint()
+        colormin :: value of the minimum color in the scale. See `SliceViewer::setColorScaleMin()`
+        colormax :: value of the maximum color in the scale. See `SliceViewer::setColorScaleMax()`
+        colorscalelog :: value of the maximum color in the scale. See `SliceViewer::setColorScaleLog()`
+        limits :: list with the (xleft, xright, ybottom, ytop) limits to the view to show. See `SliceViewer::setXYLimits()`
         normalization :: 0=none; 1=volume (default); 2=# of events.
 
     Returns:

diff --git a/docs/source/algorithms/BayesQuasi-v1.rst b/docs/source/algorithms/BayesQuasi-v1.rst
@@ -19,7 +19,7 @@ so that the amplitudes represent their integrated areas.
 
 For a Lorentzian, the Fourier transform does the conversion:
 :math:`1/(x^{2}+\delta^{2}) \Leftrightarrow exp[-2\pi(\delta k)]`.
-If x is identified with energy E and :math:`2\pi k with t/\hbar` where t is time then:
+If x is identified with energy E and :math:`2\pi k` with :math:`t/\hbar` where t is time then:
 :math:`1/[E^{2}+(\hbar / \tau)^{2}] \Leftrightarrow exp[-t/\tau]` and :math:`\sigma` is identified with :math:`\hbar / \tau.`
 The program estimates the quasielastic components of each of the groups of spectra and requires the resolution
 file and optionally the normalisation file created by ResNorm.
@@ -52,4 +52,4 @@ Usage
 
 .. categories::
 
-.. sourcelink::
+.. sourcelink::
diff --git a/docs/source/api/python/changes.rst b/docs/source/api/python/changes.rst
diff --git a/docs/source/api/python/index.rst b/docs/source/api/python/index.rst
@@ -20,7 +20,7 @@ Reference
 .. toctree::
    :hidden:
 
-   changes
+   changes <changes>
 
 Matplotlib-like plotting interface
 ----------------------------------

diff --git a/docs/source/release/v3.10.0/index.rst b/docs/source/release/v3.10.0/index.rst
@@ -1,6 +1,6 @@
-==========================
+===========================
 Mantid 3.10.0 Release Notes
-==========================
+===========================
 
 .. figure:: ../../images/ReleaseUnderConstruction.jpg
    :class: screenshot