Documentation updates.

.gitignore

 *.pyc
+apidoc/html
+doc/html

apidoc/conf.py

@@ -12,8 +12,11 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
+import sys
+import datetime
+
+date = datetime.date.today()
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -53,7 +56,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'fslpy'
-copyright = u'2015, Paul McCarthy, FMRIB Centre'
+copyright = u'{}, Paul McCarthy, FMRIB Centre'.format(date.year)
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -274,7 +277,7 @@ texinfo_documents = [
 epub_title = u'FSLpy'
 epub_author = u'Paul McCarthy'
 epub_publisher = u'Paul McCarthy'
-epub_copyright = u'2014, Paul McCarthy'
+epub_copyright = u'{}, Paul McCarthy'.format(date.year)
 
 # The basename for the epub file. It defaults to the project name.
 #epub_basename = u'FSLpy'

apidoc/fsl.fsleyes.controls.histogramlistpanel.rst

-fsl.fsleyes.controls.histogramlistpanel module
-==============================================
-
-.. automodule:: fsl.fsleyes.controls.histogramlistpanel
-    :members:
-    :undoc-members:
-    :show-inheritance:

apidoc/fsl.fsleyes.gl.shaders.arbp.parse.rst

+fsl.fsleyes.gl.shaders.arbp.parse module
+========================================
+
+.. automodule:: fsl.fsleyes.gl.shaders.arbp.parse
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.gl.shaders.arbp.program.rst

+fsl.fsleyes.gl.shaders.arbp.program module
+==========================================
+
+.. automodule:: fsl.fsleyes.gl.shaders.arbp.program
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.gl.shaders.arbp.rst

+fsl.fsleyes.gl.shaders.arbp package
+===================================
+
+.. automodule:: fsl.fsleyes.gl.shaders.arbp
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.gl.shaders.glsl.parse.rst

+fsl.fsleyes.gl.shaders.glsl.parse module
+========================================
+
+.. automodule:: fsl.fsleyes.gl.shaders.glsl.parse
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.gl.shaders.glsl.program.rst

+fsl.fsleyes.gl.shaders.glsl.program module
+==========================================
+
+.. automodule:: fsl.fsleyes.gl.shaders.glsl.program
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.gl.shaders.glsl.rst

+fsl.fsleyes.gl.shaders.glsl package
+===================================
+
+.. automodule:: fsl.fsleyes.gl.shaders.glsl
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.plotting.dataseries.rst

+fsl.fsleyes.plotting.dataseries module
+======================================
+
+.. automodule:: fsl.fsleyes.plotting.dataseries
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.plotting.histogramseries.rst

+fsl.fsleyes.plotting.histogramseries module
+===========================================
+
+.. automodule:: fsl.fsleyes.plotting.histogramseries
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.controls.timeserieslistpanel.rst → apidoc/fsl.fsleyes.plotting.powerspectrumseries.rst

-fsl.fsleyes.controls.timeserieslistpanel module
+fsl.fsleyes.plotting.powerspectrumseries module
 ===============================================
 
-.. automodule:: fsl.fsleyes.controls.timeserieslistpanel
+.. automodule:: fsl.fsleyes.plotting.powerspectrumseries
     :members:
     :undoc-members:
     :show-inheritance:

apidoc/fsl.fsleyes.plotting.rst

+fsl.fsleyes.plotting package
+============================
+
+.. automodule:: fsl.fsleyes.plotting
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.plotting.timeseries.rst

+fsl.fsleyes.plotting.timeseries module
+======================================
+
+.. automodule:: fsl.fsleyes.plotting.timeseries
+    :members:
+    :undoc-members:
+    :show-inheritance:

apidoc/fsl.fsleyes.profiles.lightboxeditprofile.rst

-fsl.fsleyes.profiles.lightboxeditprofile module
-===============================================
-
-.. automodule:: fsl.fsleyes.profiles.lightboxeditprofile
-    :members:
-    :undoc-members:
-    :show-inheritance:

apidoc/index.rst

@@ -13,4 +13,15 @@
    fsl.fsleyes
 
    
-This is the ``fslpy`` package.
+This is the ``fslpy`` API documentation.
+
+
+Building the documentation
+--------------------------
+
+These pages have been built with the following commands (assuming that we
+are starting in the ``fslpy`` root directory)::
+
+    cd apidoc
+    rm -rf html
+    sphinx-build . html

fsl/fsleyes/actions/__init__.py

@@ -14,7 +14,7 @@ performed, enabled and disabled, and may be bound to a GUI menu item or
 button. The :class:`ActionProvider` class represents some entity which can
 perform one or more actions.  As the :class:`.FSLEyesPanel` class derives from
 :class:`ActionProvider` pretty much everything in FSLEyes is an
-:classf:`ActionProvider`. 
+:class:`ActionProvider`. 
 
 
 The :func:`action` and :func:`toggleAction` functions are intended to be used

fsl/fsleyes/colourmaps.py

@@ -997,7 +997,7 @@ class LookupTable(props.HasProperties):
 
     def getByName(self, name):
         """Returns the :class:`LutLabel` instance associated with the given
-        ``name``, or ``None`` if there is no ``LutLabel`. The name comparison
+        ``name``, or ``None`` if there is no ``LutLabel``. The name comparison
         is case-insensitive.
         """
         name = name.lower()

fsl/fsleyes/controls/clusterpanel.py

@@ -318,7 +318,7 @@ class ClusterPanel(fslpanel.FSLEyesPanel):
         .. note:: This method assumes that the given ``overlay`` is an
                   :class:`.Image` which has the same voxel dimensions as,
                   and shares the the same world coordinate system as the
-                 ``featImage``.
+                  ``featImage``.
 
         
         :arg overlay:   The overlay for which clusters are currently being

fsl/fsleyes/controls/overlaydisplaytoolbar.py

@@ -50,14 +50,14 @@ class OverlayDisplayToolBar(fsltoolbar.FSLEyesToolBar):
     .. autosummary::
        :nosignatures:
 
-       __makeDisplayTools
-       __makeVolumeOptsTools
-       __makeMaskOptsTools
-       __makeLabelOptsTools
-       __makeVectorOptsTools
-       __makeRGBVectorOptsTools
-       __makeLineVectorOptsTools
-       __makeModelOptsTools
+       _OverlayDisplayToolBar__makeDisplayTools
+       _OverlayDisplayToolBar__makeVolumeOptsTools
+       _OverlayDisplayToolBar__makeMaskOptsTools
+       _OverlayDisplayToolBar__makeLabelOptsTools
+       _OverlayDisplayToolBar__makeVectorOptsTools
+       _OverlayDisplayToolBar__makeRGBVectorOptsTools
+       _OverlayDisplayToolBar__makeLineVectorOptsTools
+       _OverlayDisplayToolBar__makeModelOptsTools
     """
     
     def __init__(self, parent, overlayList, displayCtx, viewPanel):