| 1 | name: Docs (GitHub Pages) |
| 2 | |
| 3 | on: |
| 4 | push: |
| 5 | branches: [ main ] |
| 6 | workflow_dispatch: |
| 7 | |
| 8 | permissions: |
| 9 | contents: read |
| 10 | pages: write |
| 11 | id-token: write |
| 12 | |
| 13 | concurrency: |
| 14 | group: "pages" |
| 15 | cancel-in-progress: false |
| 16 | |
| 17 | jobs: |
| 18 | build: |
| 19 | runs-on: ubuntu-latest |
| 20 | steps: |
| 21 | - uses: actions/checkout@v4 |
| 22 | |
| 23 | - name: Set up Python |
| 24 | uses: actions/setup-python@v5 |
| 25 | with: |
| 26 | python-version: '3.11' |
| 27 | |
| 28 | - name: Install MkDocs Material |
| 29 | run: | |
| 30 | python -m pip install --upgrade pip |
| 31 | pip install mkdocs-material |
| 32 | |
| 33 | - name: Build site |
| 34 | run: mkdocs build --strict |
| 35 | |
| 36 | - name: Upload artifact |
| 37 | uses: actions/upload-pages-artifact@v3 |
| 38 | with: |
| 39 | path: site |
| 40 | |
| 41 | deploy: |
| 42 | environment: |
| 43 | name: github-pages |
| 44 | url: ${{ steps.deployment.outputs.page_url }} |
| 45 | runs-on: ubuntu-latest |
| 46 | needs: build |
| 47 | steps: |
| 48 | - name: Deploy to GitHub Pages |
| 49 | id: deployment |
| 50 | uses: actions/deploy-pages@v4 |