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

Jump to bottom

Add docstrings and create API documentation automatically #16

Open

quaxalber opened this issue Oct 1, 2023 · 0 comments

Labels

Owner

quaxalber commented Oct 1, 2023 •

edited

Loading

The API is designed such that it may be consumed both via CLI and from within external Python code.

However the docs are lacking the latter variant and should be expanded.

Doing this automatically should help to keep the docs up-to-date and have it in a well-understood format.

Perhaps readthedocs.io?

quaxalber self-assigned this

quaxalber added the documentation label

quaxalber mentioned this issue

Document how to consume the API from external Python scripts #14

Closed

quaxalber removed their assignment

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