add samples to documentation

ehinman · ehinman · commit 327484a80e82 · 2025-04-23T17:11:52.000-05:00
diff --git a/dataretrieval/__init__.py b/dataretrieval/__init__.py
@@ -6,6 +6,7 @@
 from dataretrieval.utils import *
 from dataretrieval.waterwatch import *
 from dataretrieval.wqp import *
+from dataretrieval.samples import *
 
 try:
     __version__ = version("dataretrieval")
diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst
@@ -9,6 +9,7 @@ API reference
 
     nadp
     nwis
+    samples
     streamstats
     utils
     wqp
diff --git a/docs/source/reference/samples.rst b/docs/source/reference/samples.rst
@@ -0,0 +1,8 @@
+.. _samples
+
+dataretrieval.samples
+-------------------------
+
+.. automodule:: dataretrieval.samples
+    :members:
+    :special-members:
diff --git a/docs/source/userguide/dataportals.rst b/docs/source/userguide/dataportals.rst
@@ -17,6 +17,8 @@ provided below.
 +-----------------------------------+---------------------------------------------------------------+
 | Mercury Deposition Network        | https://nadp.slh.wisc.edu/networks/mercury-deposition-network |
 +-----------------------------------+---------------------------------------------------------------+
+| USGS Samples                      | https://waterdata.usgs.gov/download-samples/                  |
++-----------------------------------+---------------------------------------------------------------+
 | Streamstats                       | https://streamstats.usgs.gov                                  |
 +-----------------------------------+---------------------------------------------------------------+
 | Water Quality Portal              | https://waterqualitydata.us                                   |

-Original file line number
+Diff line change
     nadp
     nwis
 +    samples
     streamstats
     utils
     wqp