docs: Add VOLK doc build to CI

This should use the `volk_doc` build target to build the docs as part of our CI. We'll want to upload it to the website eventually. Signed-off-by: Johannes Demel <[email protected]>
jdemel · Jan 30, 2024 · 16e6a87 · 16e6a87
1 parent d605d9a
commit 16e6a87
Show file tree

Hide file tree

Showing 2 changed files with 563 additions and 242 deletions.
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -189,6 +189,25 @@ jobs:
     - name: test
       run: cd build && ctest -V
 
+  build-docs:
+    name: Build VOLK docs
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/[email protected]
+      with:
+        submodules: 'recursive'
+    - name: Install dependencies
+      run: sudo apt install python3-mako liborc-dev doxygen
+    - name: Configure
+      run: mkdir build && cd build && cmake -DCMAKE_CXX_FLAGS="-Werror" -DBUILD_EXECUTABLE=ON ..
+    - name: Build
+      run: cmake --build build --target volk_doc
+    - uses: actions/upload-artifact@v4
+      with:
+        name: volk_docs
+        path: build/html/
+
   build-windows:
 
     runs-on: windows-latest