Skip to content

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

Description

@pp-mo

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    No status
    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions