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.

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

Two API pages #63

Open
aulemahal opened this issue Jan 21, 2025 · 2 comments
Open

Two API pages #63

aulemahal opened this issue Jan 21, 2025 · 2 comments

Comments

@aulemahal
Copy link
Contributor

Generic Issue

As in xclim, we have two API pages. One is hand curated in doc/api.rst, the other is generated using sphinx-apidoc. The reason we have this in xclim is a compromise : I wanted hand-curated, @Zeitsperre preferred generated.

I don't think we should import this suboptimal solution here ;). @coxipi I suggest you slice (tranche). Generated is indeed easier to maintain, as you never forget to add things. Handmade as the advantage of letting you choose what the users see in what order (of importance).

@coxipi
Copy link
Contributor

coxipi commented Jan 21, 2025

I didn't put too much thought in this. I don't have a strong opinion on this, so I went to see what xarray does: It seems to be generated automatically?

https://github.com/pydata/xarray/blob/main/doc/api.rst

# xarray/doc/API.rst
This page provides an auto-generated summary of xarray's API. For more details and examples, refer to the relevant chapters in the main part of the documentation.
...

I think Xarray's docs are reasonnable, so we can go this route of simplicity with xsdba too

@coxipi
Copy link
Contributor

coxipi commented Jan 21, 2025

@Zeitsperre wins, sorry

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants