docs.yml

name: Documentation (GitHub Pages)

on:
  pull_request:
    branches: [dev]
    paths:
      - "docsrc/**"
      - "docs/**"
      - "README.md"
      - "requirements_dev.txt"
      - ".github/workflows/docs.yml"
  push:
    branches: [dev]
    paths:
      - "docsrc/**"
      - "docs/**"
      - "README.md"
      - "requirements_dev.txt"
      - ".github/workflows/docs.yml"

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

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Configure Pages
        uses: actions/configure-pages@v5

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

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements_dev.txt
          pip install sphinx furo sphinx-llms-txt

      - name: Build docs and generate llms files
        run: |
          cd docsrc
          # Build HTML + text output, generate compiled llms-full.txt
          make llms

      - name: Commit llms.txt files
        if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          git add llms.txt llms-full.txt
          git diff --staged --quiet || git commit -m "docs: update llms.txt files (compiled) [skip ci]"
          git push || echo "Nothing to push"

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

  deploy:
    if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
    runs-on: ubuntu-latest
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4