Automate generation of C/C++ API docs (#9997)

This commit is contained in:
Nat Kershaw (MSFT) 2021-12-10 17:45:50 -08:00 committed by GitHub
parent b000ec91cc
commit b4434c7694
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 2 deletions

30
.github/workflows/publish-c-apidocs.yml vendored Normal file
View file

@ -0,0 +1,30 @@
name: Publish C/C++ API Docs
on:
workflow_dispatch
jobs:
publish:
name: Publish C/C++ API docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install doxygen and dependencies
run: |
sudo apt update
sudo apt-get install libclang-9-dev
sudo apt-get install libclang-cpp9
wget https://www.doxygen.nl/files/doxygen-1.9.2.linux.bin.tar.gz
tar xvzf doxygen-1.9.2.linux.bin.tar.gz
- name: Run doxygen
run: |
mkdir -p build/doxygen
cd docs/c_cxx
../../doxygen-1.9.2/bin/doxygen
- name: Publish
uses: JamesIves/github-pages-deploy-action@releases/v3
with:
BRANCH: gh-pages
FOLDER: build/doxygen/html
TARGET_FOLDER: docs/api/c
CLEAN_EXCLUDE: '["_config.yml"]'

View file

@ -150,7 +150,7 @@ INLINE_INHERITED_MEMB = NO
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES
FULL_PATH_NAMES = NO
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
@ -843,7 +843,7 @@ WARN_NO_PARAMDOC = YES
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
# The default value is: NO.
WARN_AS_ERROR = FAIL_ON_WARNINGS
WARN_AS_ERROR = YES
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which