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 #9

Open

mdbecker opened this issue Dec 11, 2019 · 0 comments

Labels

2

Milestone

Member

mdbecker commented Dec 11, 2019 •

edited by jlubken

Loading

Create documentation

Ensure every file/function/class has a docstring
- Use 3.7 type annotations with from __future__ import annotations
- Use 3.8 type annotations without the future import
Make sure we can build the docs
Setup readthedocs
Update readme and project description to point to the docs

If it turns out that readthedocs is not easy to setup, split that off into a separate card.

Timebox this effort to 2 days max.

The text was updated successfully, but these errors were encountered:

mdbecker added this to the Milestone 1 milestone

mdbecker added the 2 label

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