Skip to content

Generate API documentation #74

Open
@jansel

Description

@jansel

We should create some API documentation. Some of this can be automated based on docstrings, though we also will need to write tutorials.

There are some automated tools for this. The most popular one is Sphinx, though I've heard some good things about MkDocs (with mkdocstrings plugin).

We should setup a github action to publish the generated docs to github pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions