docs.yml

name: deploy mkdocs

on:
  workflow_dispatch: # Allow manually running
  push:
    branches:
      - main
    paths: # Only redeploy docs when necessary
      - 'docs/**'
      - 'snippets/**'
      - 'mkdocs.yml'
      
permissions:
  contents: write

jobs:
  deploy-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-python@v6
        with:
          python-version: 3.14.6
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
      - uses: actions/cache@v5
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: .cache
          restore-keys: |
            mkdocs-material-
      - run: pip install mkdocs-material
      - run: mkdocs gh-deploy --force