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

Documentation to-do list #184

Open

1 of 4 tasks

ml-evs opened this issue Oct 6, 2022 · 0 comments

Assignees

Labels

Member

ml-evs commented Oct 6, 2022 •

edited

Loading

From #181:

Write design and deployment docs then clean up our current README (related Write some design documentation/notes #14)
Investigate OpenAPI + mkdocs, as well as flask + OpenAPI...
Automatically get docstrings from all modules (see mkdocstrings docs)
Inheritance of docstrings for pydantic models

ml-evs added the documentation label

ml-evs self-assigned this

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