search

xarray-contrib / xdggs

Xarray extension for DGGS
https://xdggs.readthedocs.io
Apache License 2.0
80 stars 14 forks source link

documentation #76

Closed keewis closed 6 days ago

keewis commented 1 month ago

Any good library needs documentation. We got a readme in #70, but that's rarely enough.

annefou commented 1 month ago

@keewis I am happy to help but we should first agree on what we want.

What do you have in mind for the documentation? I see that most (if not all) packages listed https://github.com/xarray-contrib uses ReadTheDoc. Should we go for this solution?

keewis commented 1 month ago

yeah, that's what I've been thinking. Really, what I would like to add as minimal documentation for now is the start page, API documentation and a tutorial that demonstrates the usage, anything else we can add later.

I've set up RTD in #79, so we should be able to make some progress here.

annefou commented 1 month ago

For the API, how about using sphinx-autoapi? We can then add installation instructions and a tutorial. How does that sound?

annefou commented 1 month ago

@keewis I started a draft PR for the doc. Happy to get feedback on the organisation, content, etc. https://github.com/xarray-contrib/xdggs/pull/80

keewis commented 1 month ago

thanks, I was about to open a PR for the API documentation. I'll try to get that in first, and we can then adapt whatever you have already.

annefou commented 1 month ago

Ok. I added autoapi. Maybe it is not good enough. It works locally.

On Wed, 23 Oct 2024 at 11:38, Justus Magin @.***> wrote:

thanks, I was about to open a PR for the API documentation. I'll try to get that in first, and we can then adapt whatever you have already.

— Reply to this email directly, view it on GitHub https://github.com/xarray-contrib/xdggs/issues/76#issuecomment-2431507341, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB6KIPB7IO6KEHQUDRWON4TZ45VCVAVCNFSM6AAAAABQBRKTIKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMZRGUYDOMZUGE . You are receiving this because you commented.Message ID: @.***>

keewis commented 6 days ago

even though it still needs improvements, we have a documentation now, so I'm closing this