documentation.yml

name: Build documentation

on:
  push:
  pull_request:
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

env:
  FORCE_COLOR: "1"

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3"

    - name: Install apt dependencies
      run: |
        sudo apt-get update
        sudo apt-get install graphviz libclang1-11 libclang-cpp11

    - name: Install doxygen from SourceForge binary archives
      env:
        DOXYGEN_VERSION: 1.9.4
      run: |
        mkdir doxygen-bin-arc && cd doxygen-bin-arc
        curl -L https://sourceforge.net/projects/doxygen/files/rel-$DOXYGEN_VERSION/doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz > doxygen.tar.gz
        gunzip doxygen.tar.gz
        tar xf doxygen.tar
        cd doxygen-$DOXYGEN_VERSION
        sudo make install

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

    - name: Build the documentation
      run: |
        make html
        rm documentation/build/html/.buildinfo

    - uses: actions/upload-artifact@v4
      with:
        name: docs build artifacts
        path: |
          documentation/build/html
          examples/*/*/xml