documentation

[keewis]

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

[annefou]

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

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]

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

[annefou]

@keewis I started a draft PR for the doc. Happy to get feedback on the organisation, content, etc. #80

[keewis]

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]

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 <#76 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB6KIPB7IO6KEHQUDRWON4TZ45VCVAVCNFSM6AAAAABQBRKTIKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMZRGUYDOMZUGE> . You are receiving this because you commented.Message ID: ***@***.***>

[keewis]

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