doc updates for api pages

awips/RadarCommon.py

@@ -30,9 +30,11 @@ def get_datetime_str(record):
     """
     Get the datetime string for a record.
 
-    :param record: the record to get data for.
+    Args:
+            record: the record to get data for.
 
-    :returns: datetime string.
+    Returns:
+            datetime string.
     """
     return str(record.getDataTime())[0:19].replace(" ","_") + ".0"
 
@@ -40,9 +42,11 @@ def get_data_type(azdat):
     """
     Get the radar file type (radial or raster).
 
-    :param azdat: Boolean.
+    Args:
+            azdat: Boolean.
 
-    :returns: Radial or raster.
+    Returns:
+            Radial or raster.
     """
     if azdat:
         dattyp = "radial"

awips/dataaccess/DataAccessLayer.py

@@ -46,6 +46,17 @@ else:
 
 
 def getMetarObs(response):
+    """
+    Processes a DataAccessLayer "obs" response into a dictionary,
+    with special consideration for multi-value parameters
+    "presWeather", "skyCover", and "skyLayerBase".
+
+    Args:
+            response: DAL getGeometry() list
+
+    Returns:
+            A dictionary of METAR obs
+    """
     from datetime import datetime
     single_val_params = ["timeObs", "stationName", "longitude", "latitude",
                          "temperature", "dewpoint", "windDir",
@@ -87,6 +98,16 @@ def getMetarObs(response):
 
 
 def getSynopticObs(response):
+    """
+    Processes a DataAccessLayer "sfcobs" response into a dictionary
+    of available parameters.
+
+    Args:
+            response: DAL getGeometry() list
+
+    Returns:
+            A dictionary of synop obs
+    """
     from datetime import datetime
     station_names = []
     params = response[0].getParameters()
@@ -109,9 +130,16 @@ def getSynopticObs(response):
 
 def getForecastRun(cycle, times):
     """
-    :param cycle: Forecast cycle reference time
+    Get the latest forecast run (list of objects) from all
-    :param times: All available times/cycles
+    all cycles and times returned from DataAccessLayer "grid"
-    :return: DataTime array for a single forecast run
+    response.
+
+    Args:
+            cycle: Forecast cycle reference time
+            times: All available times/cycles
+
+    Returns:
+            DataTime array for a single forecast run
     """
     fcstRun = []
     for t in times:

awips/dataaccess/DataNotificationLayer.py

@@ -93,7 +93,8 @@ def getGridDataUpdates(request):
     response = router.getNotificationFilter(request)
     notificationFilter = response.getNotificationFilter()
     jmsInfo = _getJmsConnectionInfo(response)
-    notifier = PyGridNotification(request, notificationFilter, requestHost=THRIFT_HOST, **jmsInfo)
+    notifier = PyGridNotification(request, notificationFilter,
+                                  requestHost=THRIFT_HOST, **jmsInfo)
     return notifier
 
 
@@ -111,7 +112,8 @@ def getGeometryDataUpdates(request):
     response = router.getNotificationFilter(request)
     notificationFilter = response.getNotificationFilter()
     jmsInfo = _getJmsConnectionInfo(response)
-    notifier = PyGeometryNotification(request, notificationFilter, requestHost=THRIFT_HOST, **jmsInfo)
+    notifier = PyGeometryNotification(request, notificationFilter,
+                                      requestHost=THRIFT_HOST, **jmsInfo)
     return notifier
 
 

docs/source/api/CombinedTimeQuery.rst

@@ -0,0 +1,7 @@
+=================
+CombinedTimeQuery
+=================
+
+.. automodule:: awips.dataaccess.CombinedTimeQuery
+   :members:
+   :undoc-members:

docs/source/api/IFPClient.rst

@@ -0,0 +1,7 @@
+=========
+IFPClient
+=========
+
+.. automodule:: awips.gfe.IFPClient
+   :members:
+   :undoc-members:

docs/source/api/ThriftClient.rst

@@ -0,0 +1,7 @@
+======================
+ThriftClient
+======================
+
+.. automodule:: awips.ThriftClient
+   :members:
+   :undoc-members:

docs/source/api/TimeUtil.rst

@@ -0,0 +1,7 @@
+======================
+TimeUtil
+======================
+
+.. automodule:: awips.TimeUtil
+   :members:
+   :undoc-members:

docs/source/api/index.rst

@@ -12,7 +12,11 @@ API Documentation
    PyGeometryData
    SoundingsSupport
    ThriftClientRouter
+   ThriftClient
+   TimeUtil
    RadarCommon
+   IFPClient
    DateTimeConverter
+   CombinedTimeQuery
 
 * :ref:`genindex`