Documentation Pass
Closed this issue · 1 comments
vegu commented
Currently all of the documentation we have is in the readme file. They should be moved to a /docs directory
- make a /docs directory
- quickstart.md with install instructions and example
- examples.md with rest of examples
- mkdocs configuration
- github workflow to generate documentation to gh-pages
- add /docs/api directory and use
pymdgen
to autogenerate api docs- https://github.com/20c/confu/tree/main/docs/api for examples on how to set that up
jason20c commented
Added documentation for APIs except for models.py as that is giving an error.