This repository was archived by the owner on Aug 22, 2023. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #22.
Adds
mkdocs
using thematerial
theme, andmkdocstrings
to auto-generate references from the code.
This also adds an actions workflow to deploy the docs to Pages whenever a commit to
main
is pushed. You may need to enable Pages and set it to deploy using GitHub Actions, but this might be done automatically withactions/configure-pages
.In addition, I've added a gitpod configuration.
I've made this a PR as it's quite big, so just to not throw anyone else off this is a different branch.