Skip to content

Commit 5ac8e62

Browse files
authored
Update doc build instructions (#342)
1 parent 289f6a9 commit 5ac8e62

File tree

3 files changed

+833
-103
lines changed

3 files changed

+833
-103
lines changed

.github/workflows/ci.yml

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,13 @@ jobs:
481481
fail-fast: false
482482
matrix:
483483
include:
484+
- name: ubu22-x86-gcc12-clang-repl-19-docs
485+
os: ubuntu-22.04
486+
compiler: gcc-12
487+
clang-runtime: '19'
488+
cling: Off
489+
cppyy: Off
490+
documentation: On
484491
- name: ubu22-x86-gcc12-clang-repl-19-cppyy
485492
os: ubuntu-22.04
486493
compiler: gcc-12
@@ -754,7 +761,7 @@ jobs:
754761
run: |
755762
# Install deps
756763
sudo apt-get update
757-
sudo apt-get install git g++ debhelper devscripts gnupg python3
764+
sudo apt-get install git g++ debhelper devscripts gnupg python3 doxygen graphviz python3-sphinx
758765
sudo apt-get install -y libc6-dbg
759766
sudo snap install valgrind --classic
760767
sudo apt autoremove
@@ -826,6 +833,7 @@ jobs:
826833
cmake -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \
827834
-DUSE_CLING=ON \
828835
-DUSE_REPL=OFF \
836+
-DCPPINTEROP_INCLUDE_DOCS=${{ matrix.documentation }} \
829837
-DCling_DIR=$LLVM_BUILD_DIR/tools/cling \
830838
-DLLVM_DIR=$LLVM_BUILD_DIR/lib/cmake/llvm \
831839
-DClang_DIR=$LLVM_BUILD_DIR/lib/cmake/clang \
@@ -835,21 +843,27 @@ jobs:
835843
-DLLVM_ENABLE_WERROR=On \
836844
../
837845
else
838-
cmake -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \
839-
-DUSE_CLING=OFF \
840-
-DUSE_REPL=ON \
841-
-DLLVM_DIR=$LLVM_BUILD_DIR/lib/cmake/llvm \
842-
-DClang_DIR=$LLVM_BUILD_DIR/lib/cmake/clang \
843-
-DBUILD_SHARED_LIBS=ON \
844-
-DCODE_COVERAGE=${{ env.CODE_COVERAGE }} \
845-
-DCMAKE_INSTALL_PREFIX=$CPPINTEROP_DIR \
846-
-DLLVM_ENABLE_WERROR=On \
846+
cmake -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \
847+
-DUSE_CLING=OFF \
848+
-DUSE_REPL=ON \
849+
-DCPPINTEROP_INCLUDE_DOCS=${{ matrix.documentation }} \
850+
-DLLVM_DIR=$LLVM_BUILD_DIR/lib/cmake/llvm \
851+
-DClang_DIR=$LLVM_BUILD_DIR/lib/cmake/clang \
852+
-DBUILD_SHARED_LIBS=ON \
853+
-DCODE_COVERAGE=${{ env.CODE_COVERAGE }} \
854+
-DCMAKE_INSTALL_PREFIX=$CPPINTEROP_DIR \
855+
-DLLVM_ENABLE_WERROR=On \
847856
../
848857
fi
849858
os="${{ matrix.os }}"
850-
cmake --build . --target check-cppinterop --parallel ${{ env.ncpus }}
851-
if [[ ("${os}" == "ubuntu"*) ]]; then
852-
valgrind --show-error-list=yes --track-origins=yes --error-exitcode=1 unittests/CppInterOp/CppInterOpTests
859+
docs_on=$(echo "${{ matrix.documentation }}" | tr '[:lower:]' '[:upper:]')
860+
if [[ "${docs_on}" == "ON" ]]; then
861+
cmake --build . --target doxygen-cppinterop --parallel ${{ env.ncpus }}
862+
else
863+
cmake --build . --target check-cppinterop --parallel ${{ env.ncpus }}
864+
if [[ ("${os}" == "ubuntu"*) ]]; then
865+
valgrind --show-error-list=yes --track-origins=yes --error-exitcode=1 unittests/CppInterOp/CppInterOpTests
866+
fi
853867
fi
854868
cd ..
855869
# We need CB_PYTHON_DIR later

0 commit comments

Comments
 (0)