feat: added -DMSE_DOXYGEN flag to toggle building docs

SquireTournamentServices · Feb 19, 2024 · d93c212 · d93c212
1 parent e083efb
commit d93c212
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -232,8 +232,8 @@ set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/scripts/cmake)
 
 if(UNIX)
   # Setup docs
-  find_package(doxygen)
-  if(DOXYGEN_FOUND)
+  option(MSE_DOXYGEN OFF)
+  if(MSE_DOXYGEN)
     find_package(doxygen REQUIRED dot OPTIONAL_COMPONENTS mscgen dia)
     doxygen_add_docs(mse-docs ${SRC} ${TESTS}
                      "Generate documentation pages for ${REPO_URL}")

diff --git a/README.md b/README.md
@@ -47,7 +47,9 @@ cd build
 # ./build/
 # You can use -DMSE_WEB_API=ON to build the web api
 # You can use -DUSE_JEMALLOC=ON to build with Jemalloc (recommended)
+# You can use -DMSE_DOXYGEN=ON to generate documentation
 cmake .. 
+# cmake -DMSE_WEB_API=ON -DUSE_JEMALLOC=ON ..
 cmake --build . -j
 
 ctest -V -j # Runs all the tests