- Notifications
You must be signed in to change notification settings - Fork69
Fix command to run tests in README#145
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| name:Build and deploy docs | |
| on: | |
| push: | |
| branches:["master"] | |
| workflow_dispatch: | |
| permissions: | |
| contents:read | |
| pages:write | |
| id-token:write | |
| concurrency: | |
| group:"pages" | |
| cancel-in-progress:true | |
| jobs: | |
| build: | |
| runs-on:ubuntu-latest | |
| steps: | |
| -name:Checkout | |
| uses:actions/checkout@v5 | |
| -name:Setup Pages | |
| uses:actions/configure-pages@v5 | |
| -name:Install uv | |
| uses:astral-sh/setup-uv@v4 | |
| with: | |
| version:"latest" | |
| -name:Setup Python | |
| run:uv python install 3.9 | |
| -name:Create virtual environment | |
| run:uv venv | |
| -name:Install MkDocs and plugins | |
| run:| | |
| uv pip install --upgrade mkdocs mkdocs-material mkdocstrings[python] pillow cairosvg | |
| -name:Build site (_site directory name is used for Jekyll compatiblity) | |
| run:uv run mkdocs build --config-file ./mkdocs.yml --site-dir ./_site | |
| -name:Upload artifact | |
| uses:actions/upload-pages-artifact@v3 | |
| with: | |
| path:./_site | |
| deploy: | |
| needs:build | |
| runs-on:ubuntu-latest | |
| environment: | |
| name:github-pages | |
| steps: | |
| -name:Deploy to GitHub Pages | |
| id:deployment | |
| uses:actions/deploy-pages@v4 |