docs.yaml

name: Deploy Docs
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

permissions:
  contents: write

jobs:
  run-tests:
    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'

      - name: Install dependencies
        run: |
          pip install .

      - name: Run test script
        run: |
          chmod +x tests/run_tests.sh
          ./tests/run_tests.sh

  build-and-deploy:
    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'

      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y ffmpeg
          pip install -r docs_requirements.txt
          pip install .

      - name: Generate examples figures
        run: |
          for f in examples/*.py; do 
            echo "Processing $f..."
            python "$f" -j 2 || exit 1
          done

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

      - name: Upload Documentation Artifact
        uses: actions/upload-artifact@v4
        with:
          name: docs-preview
          path: ./docs/_build/html

      - name: Deploy to GitHub Pages
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build/html