deploy-docs.yml

name: Deploy MkDocs documentation

on:
  push:
    branches: [ master, main ]
  workflow_dispatch:

permissions:
  contents: write

concurrency:
  group: deploy-docs-${{ github.ref }}
  cancel-in-progress: true

jobs:
  deploy:
    name: Build and publish gh-pages
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v7

      - name: Set up Python
        uses: actions/setup-python@v7
        with:
          python-version: "3.x"

      - name: Install MkDocs dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -r docs/requirements-mkdocs.txt

      - name: Generate compatibility tables
        run: python docs/generate_compatibility.py

      - name: Build MkDocs site
        run: mkdocs build --strict --site-dir site

      - name: Publish gh-pages branch
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: site
          force_orphan: true
          keep_files: false