Development¶
Run tests¶
Lint¶
Type check¶
Build package artifacts¶
Build documentation locally¶
GitHub Actions¶
The provided workflow does two things:
- Runs unit tests on every push, pull request, and manual dispatch.
- Builds and deploys the MkDocs site to GitHub Pages only on pushes to
main.
Before the Pages deployment works, set the repository's Pages source to GitHub Actions in repository settings.