build-docs.yml

name: Sphinx docs to gh-pages

on:
  push:
    branches: [main]

permissions:
  contents: read
  pages: write
  id-token: write
    
jobs:
  build-docs:
    runs-on: ubuntu-latest
    
    permissions:
      contents: read
      # Needed to upload the artifact containing the built docs
      # The 'pages: write' and 'id-token: write' are required for deploying to GitHub Pages
      pages: write
      id-token: write

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.13'
      
      - name: Install dependencies
        run: |
          pip install --upgrade pip
          pip install -r docs/requirements.txt

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

      - name: Upload generated HTML as artifact
        id: deployment
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/_build/html

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