deploy_docs.yml

name: Docs

on:
  push:
    branches:
      - main
      - '**docs**'
    paths:
      - 'docs/**'
      - '.github/workflows/deploy_docs.yml'

jobs:
  build-docs:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

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

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install sphinx docutils
          pip install -r docs/requirements.txt || true

      - name: Build Sphinx documentation
        run: |
          sphinx-build -b html docs/ docs/_build/html

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

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