Documentation Pass #16

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

Closed

6 tasks done

vegu opened this issue Jul 11, 2022 · 1 comment · Fixed by #18

Assignees

Contributor

vegu commented Jul 11, 2022 •

edited by jason20c

Loading

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

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

vegu assigned jason20c

jason20c linked a pull request

that will close this issue

Documentation pass #18

Merged

Collaborator

jason20c commented Jul 20, 2022

Added documentation for APIs except for models.py as that is giving an error.

vegu closed this as completed in #18

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