You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
The text was updated successfully, but these errors were encountered:
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?
# 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
Generic Issue
As in xclim, we have two API pages. One is hand curated in
doc/api.rst
, the other is generated usingsphinx-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).
The text was updated successfully, but these errors were encountered: