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.

Sign up for GitHub

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

Basic documentation #2

Open

3 tasks

thijsmie opened this issue Jan 29, 2024 · 1 comment

Labels

Milestone

Owner

thijsmie commented Jan 29, 2024

Basic API documentation needs to be in place. This has the following subtasks:

Annotate all public API functions with a docstring
Setup mkdocs
Write an introduction with basic usage

thijsmie added the documentation label

thijsmie added this to the 0.9.0 milestone

Contributor

matthieuEv commented Mar 8, 2024

For the documentation, i think pDoc could also be a good option

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment