documentation.yml

name: Generate Sphinx Documentation

# Add permissions configuration
permissions:
  contents: write
  pages: write
  id-token: write

# Environment configuration
env:
  PYTHON_VERSION: '3.x'

# Configure GitHub Pages
concurrency:
  group: "pages"
  cancel-in-progress: true

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
  workflow_dispatch:


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

    - name: Setup Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.x'

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt
        # Create empty mock module for pyaudio
        mkdir -p mock_modules
        echo "class PyAudio: pass" > mock_modules/pyaudio.py
        echo "class Stream: pass" >> mock_modules/pyaudio.py
        PYTHONPATH=$PYTHONPATH:./mock_modules

    - name: Build documentation
      env:
        PYTHONPATH: ./mock_modules:$PYTHONPATH
      run: |
        cd docs
        sphinx-build -M html source build -v

    - name: Setup Pages
      uses: actions/configure-pages@v4

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

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