Add notes for SNOTEL, CUAHSI; add sphinx napoleon extension

ulmo-dev / ulmo

clean, simple and fast access to public hydrology and climatology data.

http://ulmo.readthedocs.org

Other

169 stars 63 forks source link

Add notes for SNOTEL, CUAHSI; add sphinx napoleon extension #183

Closed emiliom closed 4 years ago

emiliom commented 4 years ago

Addresses #171

Added CUAHSI WOF get_values notes for SNOTEL service and CUAHSI HydroPortal start and end parameters
Created cuahsi/wof/README.rst file to add extended notes (docstrings), replacing rst docstring in cuahsi/wof/init.py
Added sphinx extension sphinx.ext.napoleon. All parameter docstrings are now better formatted
Various cosmetic or spelling corrections

emiliom commented 4 years ago

The tests that are failing (usace_rivergages_test.py and usgs_nwis_test.py::test_get_site_data_single_site_with_period) have nothing to do with the changes in this PR, which are mostly to docstrings and sphinx documentation machinery. Besides, those tests were passing recently. For usace_rivergages_test.py, the domain http://rivergages.mvr.usace.army.mil/ is currently offline (hopefully a temporary glitch).