-
Notifications
You must be signed in to change notification settings - Fork 17
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.
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
Documentation Updates 📖 #35
Conversation
I have make some slight changes to fix the issue with some of the badges in the README links to address #36. I also modified the admonition box at the top the README looking for maintainers for this project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Took a quick look and it's looking nice.
Instead of adding author names & emails to each one, shall we remove that and add "Co-authored-by" to the git commit message instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is awesome, thank you for taking the time to improve the docs here!
A few nitpicky comments :).
Co-authored-by: Jacob Tomlinson <[email protected]>
Co-authored-by: Max Jones <[email protected]>
@maxrjones, @negin513 I removed the explicit names from each notebook. Instead I added Max as a co-author on the git commit. Since we squash merge it will help everyone get credit. |
Sounds good! Thanks! |
Negin, this is an amazing improvement. Thank you again! |
* upstream/main: Documentation Updates 📖 (xarray-contrib#35) [pre-commit.ci] pre-commit autoupdate (xarray-contrib#37) [pre-commit.ci] pre-commit autoupdate (xarray-contrib#34) [pre-commit.ci] pre-commit autoupdate (xarray-contrib#32) Update .pre-commit-config.yaml (xarray-contrib#28) Expand installation doc (xarray-contrib#27)
Hey Everyone,
This PR includes a comprehensive rehaul/updates of cupy-xarray documentation.
It should cover all the topic discussed in issue/#33 and much more (including demos).
It includes an update index page and the following topics :
The inspiration for this documentation update came from the materials we presented for cupy-xarray at SciPy 2023. Thanks to @dcherian for suggesting to update the documentations here.
Special thanks to @maxrjones and @dcherian!