docs.yml

name: Documentation

on:
  push:
    branches: [ main, master, develop ]
  pull_request:
    branches: [ main, master, develop ]
  workflow_dispatch:

jobs:
  build-docs:
    name: Build Sphinx Documentation
    runs-on: ubuntu-latest

    steps:
    - name: Checkout code
      uses: actions/checkout@v4

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

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e ".[docs]"

    - name: Build documentation
      run: |
        cd docs
        sphinx-build -b html source build/html

    - name: Upload documentation artifacts
      uses: actions/upload-artifact@v4
      if: success()
      with:
        name: documentation
        path: docs/build/html/
        retention-days: 7