From a21dd9de5b2d48c05e4e88c3cf6626874b800b5b Mon Sep 17 00:00:00 2001 From: Jabber Developer Date: Wed, 10 Sep 2025 17:21:57 +0200 Subject: [PATCH] ci: add GitHub Actions workflow to test C and Python API doc generation Introduce separate jobs to test C (Doxygen) and Python (Sphinx) API documentation generation. Ensures build failures are caught early, as API changes often produce warnings that developers miss without automated checks. --- .github/workflows/main.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 487e5282..45edd2b3 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -90,3 +90,31 @@ jobs: - name: Check spelling run: | codespell + + 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 profanity/apidocs/c/ + rm -rf html && 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 profanity/apidocs/python/ + sphinx-apidoc -f -o . src && make -j$(nproc) xml