From e403c05872df83e97fc1c635e406afd46d7aadb9 Mon Sep 17 00:00:00 2001 From: "Jason A. Regina" Date: Tue, 3 Dec 2024 10:28:55 -0600 Subject: [PATCH] Update nwm docs (#270) * update nwm client docs * update version --- docs/conf.py | 4 ++-- docs/hydrotools.nwm_client.AzureFileCatalog.rst | 8 ++++++++ docs/hydrotools.nwm_client.FileDownloader.rst | 8 ++++++++ docs/hydrotools.nwm_client.GCPFileCatalog.rst | 8 ++++++++ docs/hydrotools.nwm_client.HTTPFileCatalog.rst | 8 ++++++++ docs/hydrotools.nwm_client.NWMClient.rst | 8 ++++++++ docs/hydrotools.nwm_client.NWMClientDefaults.rst | 8 ++++++++ docs/hydrotools.nwm_client.NWMFileCatalog.rst | 8 ++++++++ docs/hydrotools.nwm_client.NWMFileClient.rst | 8 ++++++++ docs/hydrotools.nwm_client.NWMFileProcessor.rst | 8 ++++++++ docs/hydrotools.nwm_client.ParquetStore.rst | 8 ++++++++ docs/hydrotools.nwm_client.UnitHandler.rst | 8 ++++++++ docs/hydrotools.nwm_client.gcp.rst | 8 -------- docs/hydrotools.nwm_client.http.rst | 8 -------- docs/hydrotools.nwm_client.rst | 14 +++++++++++--- docs/hydrotools.nwm_client.utils.rst | 8 -------- 16 files changed, 101 insertions(+), 29 deletions(-) create mode 100644 docs/hydrotools.nwm_client.AzureFileCatalog.rst create mode 100644 docs/hydrotools.nwm_client.FileDownloader.rst create mode 100644 docs/hydrotools.nwm_client.GCPFileCatalog.rst create mode 100644 docs/hydrotools.nwm_client.HTTPFileCatalog.rst create mode 100644 docs/hydrotools.nwm_client.NWMClient.rst create mode 100644 docs/hydrotools.nwm_client.NWMClientDefaults.rst create mode 100644 docs/hydrotools.nwm_client.NWMFileCatalog.rst create mode 100644 docs/hydrotools.nwm_client.NWMFileClient.rst create mode 100644 docs/hydrotools.nwm_client.NWMFileProcessor.rst create mode 100644 docs/hydrotools.nwm_client.ParquetStore.rst create mode 100644 docs/hydrotools.nwm_client.UnitHandler.rst delete mode 100644 docs/hydrotools.nwm_client.gcp.rst delete mode 100644 docs/hydrotools.nwm_client.http.rst delete mode 100644 docs/hydrotools.nwm_client.utils.rst diff --git a/docs/conf.py b/docs/conf.py index 0fc75aa6..21bcd291 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,11 +19,11 @@ # -- Project information ----------------------------------------------------- project = 'OWPHydroTools' -copyright = '2021, Jason A. Regina and Austin Raney' +copyright = '2021-2024, Jason A. Regina and Austin Raney' author = 'Jason A. Regina and Austin Raney' # The full version, including alpha/beta/rc tags -release = '2.1.2' +release = '2.4.0' # -- General configuration --------------------------------------------------- diff --git a/docs/hydrotools.nwm_client.AzureFileCatalog.rst b/docs/hydrotools.nwm_client.AzureFileCatalog.rst new file mode 100644 index 00000000..f56b5203 --- /dev/null +++ b/docs/hydrotools.nwm_client.AzureFileCatalog.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.AzureFileCatalog module +============================================== + +.. automodule:: hydrotools.nwm_client.AzureFileCatalog + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.FileDownloader.rst b/docs/hydrotools.nwm_client.FileDownloader.rst new file mode 100644 index 00000000..2f6000ef --- /dev/null +++ b/docs/hydrotools.nwm_client.FileDownloader.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.FileDownloader module +============================================ + +.. automodule:: hydrotools.nwm_client.FileDownloader + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.GCPFileCatalog.rst b/docs/hydrotools.nwm_client.GCPFileCatalog.rst new file mode 100644 index 00000000..3c72f35c --- /dev/null +++ b/docs/hydrotools.nwm_client.GCPFileCatalog.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.GCPFileCatalog module +============================================ + +.. automodule:: hydrotools.nwm_client.GCPFileCatalog + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.HTTPFileCatalog.rst b/docs/hydrotools.nwm_client.HTTPFileCatalog.rst new file mode 100644 index 00000000..0d0d5189 --- /dev/null +++ b/docs/hydrotools.nwm_client.HTTPFileCatalog.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.HTTPFileCatalog module +============================================= + +.. automodule:: hydrotools.nwm_client.HTTPFileCatalog + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.NWMClient.rst b/docs/hydrotools.nwm_client.NWMClient.rst new file mode 100644 index 00000000..96184888 --- /dev/null +++ b/docs/hydrotools.nwm_client.NWMClient.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.NWMClient module +======================================= + +.. automodule:: hydrotools.nwm_client.NWMClient + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.NWMClientDefaults.rst b/docs/hydrotools.nwm_client.NWMClientDefaults.rst new file mode 100644 index 00000000..af444b08 --- /dev/null +++ b/docs/hydrotools.nwm_client.NWMClientDefaults.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.NWMClientDefaults module +=============================================== + +.. automodule:: hydrotools.nwm_client.NWMClientDefaults + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.NWMFileCatalog.rst b/docs/hydrotools.nwm_client.NWMFileCatalog.rst new file mode 100644 index 00000000..cbf806dd --- /dev/null +++ b/docs/hydrotools.nwm_client.NWMFileCatalog.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.NWMFileCatalog module +============================================ + +.. automodule:: hydrotools.nwm_client.NWMFileCatalog + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.NWMFileClient.rst b/docs/hydrotools.nwm_client.NWMFileClient.rst new file mode 100644 index 00000000..8cef8dd1 --- /dev/null +++ b/docs/hydrotools.nwm_client.NWMFileClient.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.NWMFileClient module +=========================================== + +.. automodule:: hydrotools.nwm_client.NWMFileClient + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.NWMFileProcessor.rst b/docs/hydrotools.nwm_client.NWMFileProcessor.rst new file mode 100644 index 00000000..4e825326 --- /dev/null +++ b/docs/hydrotools.nwm_client.NWMFileProcessor.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.NWMFileProcessor module +============================================== + +.. automodule:: hydrotools.nwm_client.NWMFileProcessor + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.ParquetStore.rst b/docs/hydrotools.nwm_client.ParquetStore.rst new file mode 100644 index 00000000..63555802 --- /dev/null +++ b/docs/hydrotools.nwm_client.ParquetStore.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.ParquetStore module +========================================== + +.. automodule:: hydrotools.nwm_client.ParquetStore + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.UnitHandler.rst b/docs/hydrotools.nwm_client.UnitHandler.rst new file mode 100644 index 00000000..caddcce4 --- /dev/null +++ b/docs/hydrotools.nwm_client.UnitHandler.rst @@ -0,0 +1,8 @@ +hydrotools.nwm\_client.UnitHandler module +========================================= + +.. automodule:: hydrotools.nwm_client.UnitHandler + :members: + :undoc-members: + :show-inheritance: + :private-members: diff --git a/docs/hydrotools.nwm_client.gcp.rst b/docs/hydrotools.nwm_client.gcp.rst deleted file mode 100644 index 4ecba84d..00000000 --- a/docs/hydrotools.nwm_client.gcp.rst +++ /dev/null @@ -1,8 +0,0 @@ -hydrotools.nwm\_client.gcp module -================================= - -.. automodule:: hydrotools.nwm_client.gcp - :members: - :undoc-members: - :show-inheritance: - :private-members: diff --git a/docs/hydrotools.nwm_client.http.rst b/docs/hydrotools.nwm_client.http.rst deleted file mode 100644 index 51172bf4..00000000 --- a/docs/hydrotools.nwm_client.http.rst +++ /dev/null @@ -1,8 +0,0 @@ -hydrotools.nwm\_client.http module -================================== - -.. automodule:: hydrotools.nwm_client.http - :members: - :undoc-members: - :show-inheritance: - :private-members: diff --git a/docs/hydrotools.nwm_client.rst b/docs/hydrotools.nwm_client.rst index 782f54e6..39b59aea 100644 --- a/docs/hydrotools.nwm_client.rst +++ b/docs/hydrotools.nwm_client.rst @@ -7,9 +7,17 @@ Submodules .. toctree:: :maxdepth: 4 - hydrotools.nwm_client.gcp - hydrotools.nwm_client.http - hydrotools.nwm_client.utils + hydrotools.nwm_client.AzureFileCatalog + hydrotools.nwm_client.FileDownloader + hydrotools.nwm_client.GCPFileCatalog + hydrotools.nwm_client.HTTPFileCatalog + hydrotools.nwm_client.NWMClient + hydrotools.nwm_client.NWMClientDefaults + hydrotools.nwm_client.NWMFileCatalog + hydrotools.nwm_client.NWMFileClient + hydrotools.nwm_client.NWMFileProcessor + hydrotools.nwm_client.ParquetStore + hydrotools.nwm_client.UnitHandler Module contents --------------- diff --git a/docs/hydrotools.nwm_client.utils.rst b/docs/hydrotools.nwm_client.utils.rst deleted file mode 100644 index 366cf622..00000000 --- a/docs/hydrotools.nwm_client.utils.rst +++ /dev/null @@ -1,8 +0,0 @@ -hydrotools.nwm\_client.utils module -=================================== - -.. automodule:: hydrotools.nwm_client.utils - :members: - :undoc-members: - :show-inheritance: - :private-members: