Don't build docs by default

Author: gavv

.github/workflows/build.yml

@@ -21,8 +21,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Build
-        run: make
+      - name: Release build
+        run: make release_build
+
+      - name: Debug build
+        run: make debug_build
 
       - name: Test
         run: make test

CMakeLists.txt

@@ -2,6 +2,8 @@ cmake_minimum_required(VERSION 3.0.0)
 
 project(aspl CXX)
 
+option(BUILD_DOCUMENTATION "Build Doxygen documentation" OFF)
+
 set(PACKAGE_NAME libASPL)
 set(PACKAGE_VERSION 1.0.0)
 
@@ -258,15 +260,17 @@ if(BUILD_TESTING)
     )
 endif(BUILD_TESTING)
 
-find_package(Doxygen)
-
-if(DOXYGEN_FOUND STREQUAL YES)
-  add_custom_target(doxygen ALL
-    DEPENDS ${LIB_TARGET}
-    COMMENT "Generating HTML documentation"
-    COMMAND cd "${PROJECT_SOURCE_DIR}" && doxygen
-    )
-endif()
+if(BUILD_DOCUMENTATION)
+  find_package(Doxygen)
+
+  if(DOXYGEN_FOUND STREQUAL YES)
+    add_custom_target(doxygen ALL
+      DEPENDS ${LIB_TARGET}
+      COMMENT "Generating HTML documentation"
+      COMMAND cd "${PROJECT_SOURCE_DIR}" && doxygen
+      )
+  endif()
+endif(BUILD_DOCUMENTATION)
 
 add_custom_target(compile_commands ALL
   DEPENDS ${LIB_TARGET}

Makefile

@@ -20,7 +20,11 @@ release_build:
 debug_build:
 	mkdir -p build/Debug
 	cd build/Debug && $(CMAKE) $(CMAKE_ARGS) \
-		-DCMAKE_BUILD_TYPE=Debug -DENABLE_SANITIZERS=ON -DBUILD_TESTING=ON ../..
+		-DCMAKE_BUILD_TYPE=Debug \
+		-DENABLE_SANITIZERS=ON \
+		-DBUILD_TESTING=ON \
+		-DBUILD_DOCUMENTATION=ON \
+		../..
 	cd build/Debug && make -j$(NUM_CPU)
 
 .PHONY: test

example/CMakeLists.txt

@@ -7,7 +7,7 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
 # set to non-empty string to enable code signing
-set(CODESIGN_ID "" CACHE STRING "codesign ID")
+set(CODESIGN_ID "" CACHE STRING "Codesign ID")
 
 set(DRIVER_NAME "ASPL_Example")
 set(DRIVER_VERSION "1.0.0")