action.yml

name: "Build Documentation"
description: "Build Sphinx documentation"
inputs:
  python-version:
    description: "Python version to use"
    required: false
    default: "3.10"
  treat-warnings-as-errors:
    description: "Treat warnings as errors (-W flag)"
    required: false
    default: "false"
runs:
  using: "composite"
  steps:
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: ${{ inputs.python-version }}

    - name: Install pandoc
      shell: bash
      run: |
        sudo apt-get update
        sudo apt-get install -y pandoc

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

    - name: Build Sphinx docs
      shell: bash
      run: |
        cd docs
        if [ "${{ inputs.treat-warnings-as-errors }}" = "true" ]; then
          sphinx-build -b html -W --keep-going source build/html
        else
          sphinx-build -b html source build/html
        fi