Skip to content

Clean up documentation #12

@oskar-taubert

Description

@oskar-taubert

The information currently in the readme should go into docstrings, that then generate the API reference.
Library structure can go into a static document or a contributing guide, if required.

The autoapi formatting is still quite broken and needs some attention.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions