material-for-mkdocs.yaml

name: publish documentation
on:
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: write
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/configure-pages@v4
      - uses: actions/setup-python@v5
        with:
          python-version: 3.x
      - name: install mkdocs-material
        run: pip install mkdocs-material
      - name: install other python dependencies
        run: pip install $(mkdocs get-deps)
        working-directory: docs
      - name: build static site
        run: mkdocs build --site-dir public
        working-directory: docs
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: "docs/public"
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4