Issue
Documentation is currently broken. Content is embedded dynamically in the repo actions and is difficult to build and validate locally.
Proposed Change
Update the process to build and publish documentation. A few ideas:
- Use something like
pydoc-markdown to render the docs from markdown files
- Add tooling to build and validate documentation locally
- Update actions to build and deploy the docs
Issue
Documentation is currently broken. Content is embedded dynamically in the repo actions and is difficult to build and validate locally.
Proposed Change
Update the process to build and publish documentation. A few ideas:
pydoc-markdownto render the docs from markdown files