Fix pathing so new waterdata documentation is available#189
Fix pathing so new waterdata documentation is available#189ehinman merged 2 commits intoDOI-USGS:mainfrom
Conversation
|
@jzemmels can you take a quick look at this PR I made that fixes a documentation typo? I want to make sure that info is available before sharing the news of the new waterdata module. Thanks! |
jzemmels
left a comment
There was a problem hiding this comment.
Looks good. I'm not able to emulate the same environment for building the Sphinx docs, so I can't verify that this fixed the issue. But the GitHub action logs suggest the docs succeeded, so we can check after merging to main.
| To install the "main" branch directly from GitHub, use: | ||
|
|
||
| ```bash | ||
| pip install git+https://github.com/DOI-USGS/dataretrieval-python.git |
There was a problem hiding this comment.
Maybe not worth a mention, but I don't think this works for us since it just uses HTTP. I get a "SSL certificate problem: self-signed certificate in certificate chain" that happens any time I try to clone from GitHub with HTTP. And pip install git+ssh://github.com/DOI-USGS/dataretrieval-python.git didn't work either.
There was a problem hiding this comment.
Oh interesting! It works for me. Maybe it's a Mac vs PC thing? Maybe it's a specific environment thing?
Thanks for the quick review, @jzemmels. For future reference, you should be able to clone the repo, create a new environment that uses the |
This small PR fixes the .rst pathing so that the new waterdata documentation appears in the API reference.