Update nwm docs (#270)

* update nwm client docs * update version
NOAA-OWP · Dec 3, 2024 · e403c05 · e403c05
1 parent a9cfa0b
commit e403c05
Show file tree

Hide file tree

Showing 16 changed files with 101 additions and 29 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
diff --git a/docs/hydrotools.nwm_client.http.rst b/docs/hydrotools.nwm_client.http.rst
diff --git 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