docs.yml

name: Documentation

on:
  push:
    branches: [main, master]
    tags:
      - 'v*'
  pull_request:
    branches: [main, master]
  workflow_dispatch:  # Allow manual triggering

jobs:
  build-docs:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
      with:
        fetch-depth: 0  # Full history for setuptools-scm versioning

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

    - name: Install system dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y pandoc

    - name: Install Python dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r doc/requirements.txt

    - name: Build documentation
      run: |
        cd doc
        make html
      env:
        SPHINXOPTS: "--keep-going"  # Continue on errors, don't fail on warnings

    - name: Upload documentation artifacts
      uses: actions/upload-artifact@v4
      with:
        name: documentation-html
        path: doc/build/html/
        retention-days: 30

    # Optional: Deploy to GitHub Pages
    # Uncomment the following steps to enable GitHub Pages deployment
    # - 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: ./doc/build/html
    #     force_orphan: true