Skip to content

Commit 242d7c8

Browse files
thodson-usgsclaude
andcommitted
docs: fix obvious pre-existing Sphinx build warnings
Clears 6 of the 10 make-html warnings (none were from the httpx/migration work): - get_channel: indent wrapped bullet continuations to the bullet-text column and add a trailing blank line so the time / last_modified "Examples" lists parse as RST instead of "bullet list ends without a blank line". - get_monitoring_locations: make the two identical "list of codes" hyperlinks anonymous (__) to avoid a duplicate-target warning. - conf.py: drop the deprecated sphinx_rtd_theme display_version option. - add the referenced docs/source/_static/ directory (was configured in html_static_path but missing). Remaining warnings (left as out of scope): the legacy NWIS_Metadata autodoc duplicate and the intentional !pip cells in WaterData_demo. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 5f9f736 commit 242d7c8

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

dataretrieval/waterdata/api.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -554,11 +554,11 @@ def get_monitoring_locations(
554554
county_code : string or iterable of strings, optional
555555
The code for the county or county equivalent (parish, borough, etc.) in which
556556
the monitoring location is located. A `list of codes
557-
<https://help.waterdata.usgs.gov/code/county_query?fmt=html>`_ is available.
557+
<https://help.waterdata.usgs.gov/code/county_query?fmt=html>`__ is available.
558558
county_name : string or iterable of strings, optional
559559
The name of the county or county equivalent (parish, borough, etc.) in which
560560
the monitoring location is located. A `list of codes
561-
<https://help.waterdata.usgs.gov/code/county_query?fmt=html>`_ is available.
561+
<https://help.waterdata.usgs.gov/code/county_query?fmt=html>`__ is available.
562562
minor_civil_division_code : string or iterable of strings, optional
563563
Codes for primary governmental or administrative divisions of the county or
564564
county equivalent in which the monitoring location is located.
@@ -2751,9 +2751,10 @@ def get_channel(
27512751
* A date-time: "2018-02-12T23:20:50Z"
27522752
* A bounded interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
27532753
* Half-bounded intervals: "2018-02-12T00:00:00Z/.." or
2754-
"../2018-03-18T12:31:12Z"
2755-
* Duration objects: "P1M" for data from the past month or "PT36H" for
2756-
the last 36 hours
2754+
"../2018-03-18T12:31:12Z"
2755+
* Duration objects: "P1M" for data from the past month or "PT36H"
2756+
for the last 36 hours
2757+
27572758
channel_name : string or iterable of strings, optional
27582759
The channel name.
27592760
channel_flow : string or iterable of strings, optional
@@ -2799,9 +2800,9 @@ def get_channel(
27992800
* A date-time: "2018-02-12T23:20:50Z"
28002801
* A bounded interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
28012802
* Half-bounded intervals: "2018-02-12T00:00:00Z/.." or
2802-
"../2018-03-18T12:31:12Z"
2803+
"../2018-03-18T12:31:12Z"
28032804
* Duration objects: "P1M" for data from the past month or "PT36H" for the
2804-
last 36 hours
2805+
last 36 hours
28052806
28062807
Only features that have a last_modified that intersects the value of
28072808
datetime are selected.

docs/source/_static/.gitkeep

Whitespace-only changes.

docs/source/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,6 @@
107107

108108
html_theme_options = {
109109
"logo_only": False,
110-
"display_version": True,
111110
}
112111

113112
# Add any paths that contain custom static files (such as style sheets) here,

0 commit comments

Comments
 (0)