Skip to content

Conversation

@ehinman
Copy link
Collaborator

@ehinman ehinman commented Nov 25, 2025

This small PR fixes the .rst pathing so that the new waterdata documentation appears in the API reference.

@ehinman
Copy link
Collaborator Author

ehinman commented Nov 25, 2025

@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!

Copy link
Collaborator

@jzemmels jzemmels left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh interesting! It works for me. Maybe it's a Mac vs PC thing? Maybe it's a specific environment thing?

@ehinman
Copy link
Collaborator Author

ehinman commented Nov 26, 2025

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.

Thanks for the quick review, @jzemmels. For future reference, you should be able to clone the repo, create a new environment that uses the requirements-dev.txt file to install all the required packages, navigate to the "docs" folder within the terminal, and then run make html. That should run the Sphinx docs and create a "build" folder where you can see all the built htmls. It can be a little finnicky, though. If you've done this and run into issues, I'd be curious to know where it's messing up.

@ehinman ehinman merged commit 640e477 into DOI-USGS:main Nov 26, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants