ci: add GitHub Actions workflow to test C and Python API doc generation
Some checks failed
CI / Check coding style (pull_request) Successful in 38s
CI / Check spelling (pull_request) Successful in 19s
CI / Test C API Documentation Generation (pull_request) Failing after 27s
CI / Test Python API Documentation Generation (pull_request) Failing after 27s
CI / Linux (arch) (pull_request) Successful in 15m0s
CI / Linux (ubuntu) (pull_request) Successful in 15m8s
CI / Linux (debian) (pull_request) Successful in 15m16s
Some checks failed
CI / Check coding style (pull_request) Successful in 38s
CI / Check spelling (pull_request) Successful in 19s
CI / Test C API Documentation Generation (pull_request) Failing after 27s
CI / Test Python API Documentation Generation (pull_request) Failing after 27s
CI / Linux (arch) (pull_request) Successful in 15m0s
CI / Linux (ubuntu) (pull_request) Successful in 15m8s
CI / Linux (debian) (pull_request) Successful in 15m16s
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.
This commit is contained in:
28
.github/workflows/main.yml
vendored
28
.github/workflows/main.yml
vendored
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user