docs.yml

name: Deploy documentation

on:
  push:
    branches:
      - main
    paths:
      - "docs/**"
      - "src/**"
      - "example/**"
      - "pyproject.toml"
      - "setup.py"
      - "README.md"
      - "VERSION"
  workflow_dispatch:

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

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
          cache: "pip"

      - name: Install package + doc dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install ".[docs]"

      - name: Build Sphinx HTML
        run: |
          make -C docs html

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/_build/html

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4