profanity/.github/workflows/ci-api-docs.yml

name: CI API Docs

on:
  push:
    branches: [master]
    paths:
      - 'apidocs/**'
  pull_request:
    branches: [master]
    paths:
      - 'apidocs/**'

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  test-c-api-docs:
    runs-on: ubuntu-latest
    name: Test C API Documentation Generation
    steps:
      - uses: actions/checkout@v4
      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y --no-install-recommends make doxygen
      - name: Test C API docs generation
        run: |
          cd apidocs/c/
          doxygen c-prof.conf

  test-python-api-docs:
    runs-on: ubuntu-latest
    name: Test Python API Documentation Generation
    steps:
      - uses: actions/checkout@v4
      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y --no-install-recommends make python3-sphinx
      - name: Test Python API docs generation
        run: |
          cd apidocs/python/
          sphinx-apidoc -f -o . src && make -j$(nproc) xml SPHINXOPTS="-W --keep-going -n"