WIP: Add documentation site with Material for MkDocs #8
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: Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| permissions: | |
| contents: write | |
| concurrency: | |
| group: docs-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - name: Install dependencies | |
| run: pip install -e ".[docs]" | |
| - name: Build documentation | |
| if: github.event_name == 'pull_request' | |
| run: mkdocs build --strict | |
| - name: Deploy documentation | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| run: mkdocs gh-deploy --force |