docs.yml

name: Update GitHub Pages Documentation

on:
  # Manual refresh: Actions tab -> "Update GitHub Pages Documentation" -> Run workflow
  workflow_dispatch:
  # Auto refresh after a successful package publish
  workflow_run:
    workflows: ["Publish to PyPI"]
    types: [completed]

permissions: {}

jobs:
  deploy:
    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
    runs-on: ubuntu-latest
    # Only the deploy job needs to push the built site to the gh-pages branch.
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
        with:
          fetch-depth: 0
      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7
        with:
          python-version: '3.x'
      - name: Install docs dependencies
        run: pip install -r docs/requirements.txt
      - name: Build and deploy to GitHub Pages
        run: mkdocs gh-deploy --force --strict