Skip to content
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

Jump to bottom

Documentation adjustments #436

Merged
merged 11 commits into from
Jan 15, 2025
Merged

Documentation adjustments #436

merged 11 commits into from
Jan 15, 2025

Conversation

Zeitsperre
Copy link
Member

@Zeitsperre Zeitsperre commented Jan 8, 2025 •
edited
Loading

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • CHANGELOG.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • Updates the docs to use cleaner imports, removes some unneeded library imports
  • Fixes a few typos and grammar mistakes
  • Updates the Python version used in the docs generation
  • Updates the Ubuntu and Conda versions used on ReadTheDocs
  • Fixes a few imports within the library for better API

Does this PR introduce a breaking change?

Not really. Suggested usages are a bit different, but nothing has changed.

Zeitsperre and others added 7 commits December 13, 2024 16:33
@Zeitsperre
add temporary RavenPy logos
6443abd
@Zeitsperre
add geotiff versions
7f45ef8
@lou-a
Add new logo versions
d364e75
@lou-a
With correct resolutions
568f5f0
@Zeitsperre
crop logos, add logo to README.rst, remove old logo, adjust sphinx-co…
747072b 
…deautolink, fix imports

Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
@Zeitsperre
update docs to use cleaner imports, typo fixes, fix a few imports in …
bd9b8d3 
…library

Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
@Zeitsperre
use newer python and update image and mamba versions
1355a7d 
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
@Zeitsperre Zeitsperre requested a review from huard January 8, 2025 16:08
@Zeitsperre Zeitsperre self-assigned this Jan 8, 2025
Base automatically changed from logos to master January 14, 2025 18:44
@Zeitsperre
Merge branch 'master' into docs-fixes
09a5fb1 
# Conflicts:
#	environment-docs.yml
#	pyproject.toml
@Zeitsperre
fix logo location in README.rst
65cf310 
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
@Zeitsperre
fix bad import, use ubuntu-lts-latest in docs
9f1b7f6 
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
@coveralls
Copy link

coveralls commented Jan 14, 2025 •
edited
Loading

Coverage Status

coverage: 81.292% (+0.009%) from 81.283%
when pulling 6d697bc on docs-fixes
into 3c2f792 on master.

@Zeitsperre
update CHANGELOG.rst
6d697bc 
Signed-off-by: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com>
@Zeitsperre Zeitsperre merged commit bde10cb into master Jan 15, 2025
14 checks passed
@Zeitsperre Zeitsperre deleted the docs-fixes branch January 15, 2025 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@huard huard huard approved these changes

Assignees

@Zeitsperre Zeitsperre

Labels
CI docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Zeitsperre @coveralls @huard @lou-a