Document Checkmate codebase
parasj opened this issue · 2 comments
parasj commented
The current code base lacks any docs of any kind.
- Standardize on a single docstring format
- Finish documenting public interfaces
- Publish docs to a GH pages website using tool like https://github.com/facebook/docusaurus
- Autoreformat code on push to Github
Guides for good documentation best practices:
parasj commented
A build process should autogenerate tutorials from ipython notebooks:
parasj commented
Docs should also autodeploy via a Github action: https://github.com/marketplace/actions/deploy-to-github-pages