add missing docstrings and fix sphinx warnings (#75)

* add missing dosctrings and fix sphinx warnings

* keep flake8 happy

doc/source/conf.py

@@ -139,7 +139,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

doc/source/tuiview_viewerstrings.rst

@@ -1,5 +1,5 @@
 viewerstrings
-============
+=============
 .. automodule:: tuiview.viewerstrings
    :members:
    :undoc-members:

tuiview/geolinkedviewers.py

@@ -37,6 +37,7 @@ class GeolinkedViewers(QObject):
     # signals
     newViewerCreated = pyqtSignal(viewerwindow.ViewerWindow, 
                         name='newViewerCreated')
+    "signal emitted when a new viewer window is created"
 
     def __init__(self, loadPlugins=True):
         QObject.__init__(self)

tuiview/layerwindow.py

@@ -465,6 +465,7 @@ class LayerWindow(QDockWidget):
     """
     # signals
     layerWindowClosed = pyqtSignal('QDockWidget', name='layerWindowClosed')
+    "signal emitted when window closed"
 
     def __init__(self, parent, viewwidget):
         QDockWidget.__init__(self, "Layers", parent)

tuiview/profilewindow.py

@@ -34,6 +34,7 @@ class ProfileDockWidget(QDockWidget):
     """
     # signals
     profileClosed = pyqtSignal(QDockWidget, name='profileClosed')
+    "emitted when Window closed"
 
     def __init__(self, parent, viewwidget):
         QDockWidget.__init__(self, "Profile", parent)

tuiview/querywindow.py

@@ -650,6 +650,7 @@ class ThematicVerticalHeader(QHeaderView):
     otherwise behaves the same as the real thing.
     """
     clicked = pyqtSignal(QMouseEvent, name='clicked')
+    "emitted when header clicked"
 
     def __init__(self, parent):
         QHeaderView.__init__(self, Qt.Vertical, parent)
@@ -711,6 +712,7 @@ class QueryDockWidget(QDockWidget):
     """
     # signals
     queryClosed = pyqtSignal(QDockWidget, name='queryClosed')
+    "emitted when window closed"
 
     def __init__(self, parent, viewwidget):
         QDockWidget.__init__(self, "Query", parent)

tuiview/userexpressiondialog.py

@@ -33,8 +33,10 @@ class UserExpressionDialog(QDialog):
     # signals
     newExpression = pyqtSignal(['QString'], ['QString', int], 
                         name='newExpression')
+    "emitted when a new expression is entered"
     # not used?
     undoEdit = pyqtSignal('QObject', int, name='undoEdit')
+    "emitted when user wants to undo"
 
     def __init__(self, parent, col=None, undoObject=None):
         QDialog.__init__(self, parent)

tuiview/vectorquerywindow.py

@@ -30,6 +30,7 @@ class VectorQueryDockWidget(QDockWidget):
     Dockable window that is a combined profile and ruler
     """
     queryClosed = pyqtSignal(QDockWidget, name='queryClosed')
+    "emitted when window closed"
 
     def __init__(self, parent):
         QDockWidget.__init__(self, "Vector Query", parent)

tuiview/viewerLUT.py

@@ -123,8 +123,11 @@ class ViewerLUT(QObject):
     """
     # signals
     newProgress = pyqtSignal('QString', name='newProgress')
+    "emitted when a new progress bar is needed"
     newPercent = pyqtSignal(int, name='newPercent')
+    "emitted when a new percent value is available"
     endProgress = pyqtSignal(name='endProgress')
+    "emitted when progress finished"
 
     def __init__(self):
         QObject.__init__(self)  # so we can emit signal

tuiview/viewerlayers.py

@@ -173,6 +173,7 @@ def findBestOverview(self, imgpixperwinpix):
 
 
 NOTSET_STRING = 'Not Set'
+"Returned when one of the property items not set on the file"
 
 
 class PropertyInfo(object):
@@ -195,6 +196,7 @@ def setSR(self, sr):
         self.sr = sr
 
     def getUTMZone(self):
+        "get the UTM zone, if set"
         utmZone = NOTSET_STRING
         if self.sr is not None:
             zone = self.sr.GetUTMZone()
@@ -203,30 +205,35 @@ def getUTMZone(self):
         return utmZone
 
     def getProjection(self):
+        "get the projection, if set"
         proj = NOTSET_STRING
         if self.sr is not None:
             proj = self.sr.GetAttrValue('PROJECTION')
         return proj
 
     def getDatum(self):
+        "get the datum, if set"
         datum = NOTSET_STRING
         if self.sr is not None:
             datum = self.sr.GetAttrValue('DATUM')
         return datum
 
     def getSpheroid(self):
+        "get spheroid, if set"
         spheroid = NOTSET_STRING
         if self.sr is not None:
             spheroid = self.sr.GetAttrValue('SPHEROID')
         return spheroid
 
     def getUnits(self):
+        "get the units, if set"
         units = NOTSET_STRING
         if self.sr is not None:
             units = self.sr.GetLinearUnitsName()
         return units
 
     def getWKT(self):
+        "get the projection as a WKT"
         wkt = NOTSET_STRING
         if self.sr is not None:
             wkt = self.sr.ExportToPrettyWkt()
@@ -1260,6 +1267,7 @@ def setSQL(self, sql=None):
         self.sql = sql
 
     def getSQL(self):
+        "returns the SQL used for this layer"
         return self.sql
 
     def hasSQL(self):
@@ -1279,21 +1287,27 @@ def setLineWidth(self, linewidth):
         self.linewidth = linewidth
 
     def getLineWidth(self):
+        "gets the current line width"
         return self.linewidth
 
     def setHalfCrossSize(self, halfCrossSize):
+        "set the half cross size (used for points)"
         self.halfCrossSize = halfCrossSize
 
     def getHalfCrossSize(self):
+        "get the half cross size (used for points)"
         return self.halfCrossSize
 
     def setFieldToLabel(self, field):
+        "set the field to label (None disables)"
         self.fieldToLabel = field
 
     def getFieldToLabel(self):
+        "get the field that is being used to label"
         return self.fieldToLabel
 
     def getColorAsRGBATuple(self):
+        "Returns the current color as a tuple"
         rgba = []
         for code in viewerLUT.RGBA_CODES:
             lutindex = viewerLUT.CODE_TO_LUTINDEX[code]
@@ -1318,6 +1332,7 @@ def setLabelColor(self, color):
             self.lut[2, lutindex] = value
 
     def getLabelColorAsRGBATuple(self):
+        "Returns the current label color as a tuple"
         rgba = []
         for code in viewerLUT.RGBA_CODES:
             lutindex = viewerLUT.CODE_TO_LUTINDEX[code]
@@ -1536,6 +1551,7 @@ def setSQL(self, sql=None):
         raise NotImplementedError(msg)
 
     def getSQL(self):
+        "unlike the base class we don't support SQL"
         msg = "ViewerFeatureVectorLayer doesn't support SQL"
         raise NotImplementedError(msg)
 
@@ -1552,11 +1568,17 @@ class LayerManager(QObject):
     # use object rather than ViewerLayer for topLayerChanged
     # so we can pass None
     topLayerChanged = pyqtSignal(object, name='topLayerChanged')
+    "signal emitted when top layer changed"
     layersChanged = pyqtSignal(name='layersChanged')
+    "signal emitted when layers have changed"
     newProgressSig = pyqtSignal('QString', name='newProgress')
+    "signal emitted when a new progress bar is needed"
     endProgressSig = pyqtSignal(name='endProgress')
+    "signal emitted when progress is finished"
     newPercentSig = pyqtSignal(int, name='newPercent')
+    "signal emitted when a new progress percent is reached"
     statusMessageSig = pyqtSignal('QString', name='statusMessage')
+    "signal emitted with a new status message needs to be shown to the user"
 
     def __init__(self):
         QObject.__init__(self)

tuiview/viewerwidget.py

@@ -111,22 +111,31 @@ class ViewerWidget(QAbstractScrollArea):
     """
     # signals
     geolinkMove = pyqtSignal(GeolinkInfo, name='geolinkMove')
+    "viewer moved, geolink the others"
     geolinkQueryPoint = pyqtSignal(GeolinkInfo, 
                                 name='geolinkQueryPoint')
+    "viewer queried"
     # can't use ViewerWidget - use base class instead
     layerAdded = pyqtSignal(QAbstractScrollArea, name='layerAdded')
+    "layer added"
     showStatusMessage = pyqtSignal('QString', 
                                 name='showStatusMessage')
+    "show new status message"
     activeToolChanged = pyqtSignal(ActiveToolChangedInfo,
                                 name='activeToolChanged')
+    "active tool has changed"
     polygonCollected = pyqtSignal(PolygonToolInfo,
                                 name='polygonCollected')
+    "polygon has been collected"
     polylineCollected = pyqtSignal(PolylineToolInfo,
                                 name='polylineCollected')
+    "line has been collected"
     vectorLocationSelected = pyqtSignal(list,
                                 viewerlayers.ViewerVectorLayer,
                                 name='vectorLocationSelected')
+    "a location on a vector as been selected"
     locationSelected = pyqtSignal(QueryInfo, name='locationSelected')
+    "a location on a raster as been selected"
 
     def __init__(self, parent):
         QAbstractScrollArea.__init__(self, parent)

tuiview/viewerwindow.py

@@ -188,13 +188,19 @@ class ViewerWindow(QMainWindow):
     """
     # signals
     newWindowSig = pyqtSignal(name='newWindow')
+    "new window created"
     tileWindowsSig = pyqtSignal(int, int, object, name='tileWindows')
+    "user has requested that the windows are tiles"
     newQueryWindowSig = pyqtSignal(querywindow.QueryDockWidget,
                             name='newQueryWindow')
+    "user has opened a new query window"
     closeAllWindowsSig = pyqtSignal(name='closeAllWindows')
+    "close all tuiview windows"
     # Don't know how to specify file objects...
     writeViewersState = pyqtSignal(object, name='writeViewersState')
+    "write viewer state to a file"
     readViewersState = pyqtSignal(object, name='readViewersState')
+    "read viewer state from a tile"
 
     def __init__(self):
         QMainWindow.__init__(self)