From b4434c76946eaabb5310b1444309c49e401bd9cb Mon Sep 17 00:00:00 2001 From: "Nat Kershaw (MSFT)" Date: Fri, 10 Dec 2021 17:45:50 -0800 Subject: [PATCH] Automate generation of C/C++ API docs (#9997) --- .github/workflows/publish-c-apidocs.yml | 30 +++++++++++++++++++++++++ docs/c_cxx/Doxyfile | 4 ++-- 2 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/publish-c-apidocs.yml diff --git a/.github/workflows/publish-c-apidocs.yml b/.github/workflows/publish-c-apidocs.yml new file mode 100644 index 0000000000..db2f88dbc3 --- /dev/null +++ b/.github/workflows/publish-c-apidocs.yml @@ -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"]' + \ No newline at end of file diff --git a/docs/c_cxx/Doxyfile b/docs/c_cxx/Doxyfile index 18bcf754cd..888e0a36b3 100644 --- a/docs/c_cxx/Doxyfile +++ b/docs/c_cxx/Doxyfile @@ -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