Jabber Developer
9fd62e2304
Some checks failed
CI API Docs / Test C API Documentation Generation (pull_request) Successful in 26s
CI API Docs / Test Python API Documentation Generation (pull_request) Failing after 28s
CI Code / Check coding style (pull_request) Has been cancelled
CI Code / Check spelling (pull_request) Has been cancelled
CI Code / Linux (arch) (pull_request) Has been cancelled
CI Code / Linux (debian) (pull_request) Has been cancelled
CI Code / Linux (ubuntu) (pull_request) Has been cancelled
- The code tests will ignore doc changes and vice versa. - The CI is split in 2 parts for clarity
45 lines
1.1 KiB
YAML
45 lines
1.1 KiB
YAML
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"
|