SciTools / cf-units

Units of measure as required by the Climate and Forecast (CF) Metadata Conventions
https://cf-units.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
66 stars 49 forks source link

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

Open pp-mo opened 1 month ago

pp-mo commented 1 month ago

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!)