Skip to content

Add link to rtd documentation #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kratzert merged 13 commits into from
Oct 21, 2025
Merged

Add link to rtd documentation #59

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b6836b0
Update docstrings
kratzert Oct 21, 2025
c6363ba
Add Sphinx documentation
kratzert Oct 21, 2025
69b7f0e
Add github workflow to check docs build
kratzert Oct 21, 2025
c619aa2
Ignore docs build directory
kratzert Oct 21, 2025
4492caf
Add Sphinx dependencies
kratzert Oct 21, 2025
b3b510e
Formatting
kratzert Oct 21, 2025
f957666
Add rtd file
kratzert Oct 21, 2025
2917b21
Formatting
kratzert Oct 21, 2025
259833d
Try fix for failing docs workflow
kratzert Oct 21, 2025
a273291
Merge branch 'main' into docs
kratzert Oct 21, 2025
7a11fe0
Fix Sphinx file
kratzert Oct 21, 2025
8038b09
Merge branch 'main' into docs
kratzert Oct 21, 2025
69e769d
Add link to docs
kratzert Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ A Python package for facilitating and unifying access to global streamflow data.

Welcome to RivRetrieve-Python! We're actively developing this library to make global streamflow data more accessible. As an early-stage project, it's not yet stable, and we appreciate your understanding as things evolve. Contributions and feedback are welcome! Please check out the active development under [Issues](https://github.com/kratzert/RivRetrieve-Python/issues) or start posting under [Discussions](https://github.com/kratzert/RivRetrieve-Python/discussions).

- Documentation: [rivretrieve-python.readthedocs.io](https://rivretrieve-python.readthedocs.io/en/latest/) (Work in Progress)

## Background

This package originated as a Python translation of the [RivRetrieve R package](https://github.com/Ryan-Riggs/RivRetrieve). The initial translation was performed by Gemini, with a few manual adjustments for API changes.
Expand Down