Add an option to disable docs when building

Signed-off-by: Michael Carroll <[email protected]>
gazebosim · Jan 8, 2021 · 8143cc8 · 8143cc8
1 parent 0253110
commit 8143cc8
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/cmake/IgnCreateDocs.cmake b/cmake/IgnCreateDocs.cmake
@@ -47,6 +47,12 @@ function(ign_create_docs)
   set(oneValueArgs API_MAINPAGE_MD AUTOGENERATED_DOC TUTORIALS_MAINPAGE_MD)
   set(multiValueArgs "TAGFILES" "ADDITIONAL_INPUT_DIRS")
 
+  option(IGN_BUILD_DOCS "Build docs" ON)
+  if (NOT ${IGN_BUILD_DOCS})
+    message(STATUS "Building Documentation disabled via IGN_BUILD_DOCS")
+    return()
+  endif()
+
   #------------------------------------
   # Parse the arguments
   _ign_cmake_parse_arguments(ign_create_docs "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})