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

fully automate API docs build (apidocs/autodocs?) #453

Open
pp-mo opened this issue Sep 12, 2024 · 0 comments
Open

fully automate API docs build (apidocs/autodocs?) #453

pp-mo opened this issue Sep 12, 2024 · 0 comments

Comments

@pp-mo
Copy link
Member

pp-mo commented Sep 12, 2024

What gets a docs entry is currently manually determined - e.g. here
This means some things are left out
e.g. cf_units.CALENDARS appears in docs, but cf_units.CALENDAR_360_DAY does not, even though it is included in __all__ .

If things ought to be private, we should apply the standard dunder / all control for it.

Possible solutions are sphinx-autoapi or sphinx-apidoc+autodoc
Hints : Iris might be switching to autoapi, and geovista is already there (natch!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Status: No status
Development

No branches or pull requests

1 participant