From 37003a839f5c9bb4e96b1f6e5e4da2b8b3e7603e Mon Sep 17 00:00:00 2001 From: Michael James Date: Fri, 21 Oct 2016 17:08:32 -0500 Subject: [PATCH] add API documentation rst files --- docs/source/api/DataAccessLayer.rst | 7 +++++++ docs/source/api/DateTimeConverter.rst | 7 +++++++ docs/source/api/IDataRequest.rst | 7 +++++++ docs/source/api/PyData.rst | 7 +++++++ docs/source/api/PyGeometryData.rst | 7 +++++++ docs/source/api/PyGridData.rst | 7 +++++++ docs/source/api/RadarCommon.rst | 7 +++++++ docs/source/api/SoundingsSupport.rst | 7 +++++++ docs/source/api/ThriftClientRouter.rst | 7 +++++++ docs/source/api/index.rst | 18 ++++++++++++++++++ 10 files changed, 81 insertions(+) create mode 100644 docs/source/api/DataAccessLayer.rst create mode 100644 docs/source/api/DateTimeConverter.rst create mode 100644 docs/source/api/IDataRequest.rst create mode 100644 docs/source/api/PyData.rst create mode 100644 docs/source/api/PyGeometryData.rst create mode 100644 docs/source/api/PyGridData.rst create mode 100644 docs/source/api/RadarCommon.rst create mode 100644 docs/source/api/SoundingsSupport.rst create mode 100644 docs/source/api/ThriftClientRouter.rst create mode 100644 docs/source/api/index.rst diff --git a/docs/source/api/DataAccessLayer.rst b/docs/source/api/DataAccessLayer.rst new file mode 100644 index 0000000..e000038 --- /dev/null +++ b/docs/source/api/DataAccessLayer.rst @@ -0,0 +1,7 @@ +=============== +DataAccessLayer +=============== + +.. automodule:: awips.dataaccess.DataAccessLayer + :members: + :undoc-members: diff --git a/docs/source/api/DateTimeConverter.rst b/docs/source/api/DateTimeConverter.rst new file mode 100644 index 0000000..75949fc --- /dev/null +++ b/docs/source/api/DateTimeConverter.rst @@ -0,0 +1,7 @@ +================= +DateTimeConverter +================= + +.. automodule:: awips.DateTimeConverter + :members: + :undoc-members: diff --git a/docs/source/api/IDataRequest.rst b/docs/source/api/IDataRequest.rst new file mode 100644 index 0000000..d818819 --- /dev/null +++ b/docs/source/api/IDataRequest.rst @@ -0,0 +1,7 @@ +=============================== +IDataRequest (newDataRequest()) +=============================== + +.. autoclass:: awips.dataaccess.IDataRequest + :members: + :special-members: diff --git a/docs/source/api/PyData.rst b/docs/source/api/PyData.rst new file mode 100644 index 0000000..4097955 --- /dev/null +++ b/docs/source/api/PyData.rst @@ -0,0 +1,7 @@ +====================== +PyData +====================== + +.. automodule:: awips.dataaccess.PyData + :members: + :undoc-members: diff --git a/docs/source/api/PyGeometryData.rst b/docs/source/api/PyGeometryData.rst new file mode 100644 index 0000000..24ac092 --- /dev/null +++ b/docs/source/api/PyGeometryData.rst @@ -0,0 +1,7 @@ +====================== +PyGeometryData +====================== + +.. automodule:: awips.dataaccess.PyGeometryData + :members: + :undoc-members: diff --git a/docs/source/api/PyGridData.rst b/docs/source/api/PyGridData.rst new file mode 100644 index 0000000..860e7b9 --- /dev/null +++ b/docs/source/api/PyGridData.rst @@ -0,0 +1,7 @@ +====================== +PyGridData +====================== + +.. automodule:: awips.dataaccess.PyGridData + :members: + :undoc-members: diff --git a/docs/source/api/RadarCommon.rst b/docs/source/api/RadarCommon.rst new file mode 100644 index 0000000..4d0509e --- /dev/null +++ b/docs/source/api/RadarCommon.rst @@ -0,0 +1,7 @@ +====================== +RadarCommon +====================== + +.. automodule:: awips.RadarCommon + :members: + :undoc-members: diff --git a/docs/source/api/SoundingsSupport.rst b/docs/source/api/SoundingsSupport.rst new file mode 100644 index 0000000..527a1da --- /dev/null +++ b/docs/source/api/SoundingsSupport.rst @@ -0,0 +1,7 @@ +====================== +SoundingsSupport +====================== + +.. automodule:: awips.dataaccess.SoundingsSupport + :members: + :undoc-members: diff --git a/docs/source/api/ThriftClientRouter.rst b/docs/source/api/ThriftClientRouter.rst new file mode 100644 index 0000000..d65f137 --- /dev/null +++ b/docs/source/api/ThriftClientRouter.rst @@ -0,0 +1,7 @@ +====================== +ThriftClientRouter +====================== + +.. automodule:: awips.dataaccess.ThriftClientRouter + :members: + :undoc-members: diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst new file mode 100644 index 0000000..c18d4aa --- /dev/null +++ b/docs/source/api/index.rst @@ -0,0 +1,18 @@ +################# +API Documentation +################# + +.. toctree:: + :maxdepth: 2 + + DataAccessLayer + IDataRequest + PyData + PyGridData + PyGeometryData + SoundingsSupport + ThriftClientRouter + RadarCommon + DateTimeConverter + +* :ref:`genindex`