Merge pull request #2607 from SasView/doc_build_fixes

Fix doc build errors

docs/sphinx-docs/source/dev/dev.rst

@@ -12,6 +12,7 @@ Contents
    SasView API <sasview-api/modules>
    sasmodels overview <sasmodels-dev/index>
    sasmodels API <sasmodels-api/modules>
+   OpenGL subsystem <gl/opengl.rst>
 
 Indices and Search
 ------------------

docs/sphinx-docs/source/dev/gl/opengl.rst

@@ -1,5 +1,5 @@
 Open GL Subsystem
-==============
+=================
 
 The SasView openGL subsystem is quite minimal, and works in the standard way though a scenegraph
 
@@ -8,6 +8,6 @@ a way of checking the rendering, and catalogue the available functions
 
 
 Class Hierarchy
-===============
+^^^^^^^^^^^^^^^
 
 TODO - data currently in PR.

src/sas/qtgui/Perspectives/ParticleEditor/helper_functions.py

@@ -16,7 +16,7 @@ def step(x: np.ndarray):
 
 
 def rect(x: np.ndarray):
-    """ Rectangle function, zero if |input| > 1, 1 otherwise"""
+    """ Rectangle function, zero if mod(input) > 1, 1 otherwise"""
     out = np.zeros_like(x)
     out[np.abs(x) <= 1] = 1.0
     return out

src/sas/qtgui/Perspectives/ParticleEditor/sampling/chunking.py

@@ -6,32 +6,30 @@
 
 Something like this
 
-
-
-                 First Point
-
-       1   2   3 | 4   5   6 | 7   8   9 | 0
-   1             |           |           |
-S                |           |           |
-e  2   CHUNK 1   |  CHUNK 2  |  CHUNK 3  | CHUNK 4
-c                |           |           |
-o  3             |           |           |
-n ---------------+-----------+-----------+------------
-d  4             |           |           |
-                 |           |           |
-P  5   CHUNK 5   |  CHUNK 6  | CHUNK 7   | CHUNK 8
-o                |           |           |
-i  6             |           |           |
-n ---------------+-----------+-----------+------------
-t  7             |           |           |
-                 |           |           |
-   8   CHUNK 9   | CHUNK 10  | CHUNK 11  |  CHUNK 12
-                 |           |           |
-   9             |           |           |
-  ---------------+-----------+-----------+------------
-   0             |           |           |
-      CHUNK 13   | CHUNK 14  | CHUNK 15  |  CHUNK 16
-                 |           |           |
+.                 First Point
+
+.       1   2   3 | 4   5   6 | 7   8   9 | 0
+.   1             |           |           |
+.S                |           |           |
+.e  2   CHUNK 1   |  CHUNK 2  |  CHUNK 3  | CHUNK 4
+.c                |           |           |
+.o  3             |           |           |
+.n ---------------+-----------+-----------+------------
+.d  4             |           |           |
+.                 |           |           |
+.P  5   CHUNK 5   |  CHUNK 6  | CHUNK 7   | CHUNK 8
+.o                |           |           |
+.i  6             |           |           |
+.n ---------------+-----------+-----------+------------
+.t  7             |           |           |
+.                 |           |           |
+.   8   CHUNK 9   | CHUNK 10  | CHUNK 11  |  CHUNK 12
+.                 |           |           |
+.   9             |           |           |
+.  ---------------+-----------+-----------+------------
+.   0             |           |           |
+.      CHUNK 13   | CHUNK 14  | CHUNK 15  |  CHUNK 16
+.                 |           |           |
 """
 
 

src/sas/qtgui/Plotting/Slicers/BoxSlicer.py

@@ -494,7 +494,7 @@ class BoxInteractorX(BoxInteractor):
     """
     Average in Qx direction. The data for all Qy at a constant Qx are
     averaged together to provide a 1D array in Qx (to be plotted as a function
-     of Qx)
+    of Qx)
     """
 
     def __init__(self, base, axes, item=None, color='black', zorder=3):
@@ -528,7 +528,7 @@ class BoxInteractorY(BoxInteractor):
     """
     Average in Qy direction. The data for all Qx at a constant Qy are
     averaged together to provide a 1D array in Qy (to be plotted as a function
-     of Qy)
+    of Qy)
     """
 
     def __init__(self, base, axes, item=None, color='black', zorder=3):

src/sas/qtgui/Plotting/Slicers/WedgeSlicer.py

@@ -140,12 +140,15 @@ def _post_data(self, new_sector=None, nbins=None):
 
         :param new_sector: slicer used for directional averaging in Q or Phi
         :param nbins: the number of point plotted when averaging
-        :TODO - Unlike other slicers, the two sector types are sufficiently
-        different that this method contains three instances of If (check class name) do x.
-        The point of post_data vs _post_data I think was to avoid this kind of thing and
-        suggests that in this case we may need a new method in the WedgeInteracgtorPhi
-        and WedgeInteracgtorQ to handle these specifics. Probably by creating the 1D plot
-        object in those top level classes along with the specifc attributes.
+        
+        :TODO
+        
+        Unlike other slicers, the two sector types are sufficiently different
+        that this method contains three instances of If (check class name) do x.
+        The point of post_data vs _post_data I think was to avoid this kind of
+        thing and suggests that in this case we may need a new method in the WedgeInteracgtorPhi and WedgeInteractorQ to handle these specifics.
+        Probably by creating the 1D plot object in those top level classes along
+        with the specifc attributes.
         """
         # Data to average
         data = self.data
@@ -333,7 +336,7 @@ class WedgeInteractorQ(WedgeInteractor):
     """
     Average in Q direction. The data for all phi at a constant Q are
     averaged together to provide a 1D array in Q (to be plotted as a function
-     of Q)
+    of Q)
     """
 
     def __init__(self, base, axes, item=None, color='black', zorder=3):
@@ -350,7 +353,7 @@ class WedgeInteractorPhi(WedgeInteractor):
     """
     Average in phi direction. The data for all Q at a constant phi are
     averaged together to provide a 1D array in phi (to be plotted as a function
-     of phi)
+    of phi)
     """
 
     def __init__(self, base, axes, item=None, color='black', zorder=3):

src/sas/sascalc/realspace/VolumeCanvas.py

@@ -437,9 +437,10 @@ def getParam(self, name):
 
     def getParamList(self, shapeid=None):
         """
-	       return a full list of all available parameters from
+....       return a full list of all available parameters from
            self.params.keys(). If a key in self.params is a instance
            of ShapeDescriptor, extend the return list to:
+           
            [param1,param2,shapeid.param1,shapeid.param2.......]
 
            If shapeid is provided, return the list of parameters that