Skip to content

Commit 3770798

Browse files
committed
Enable docs only in dev mode
Because the docs require dependencies that aren't necessary otherwise, it's best to just enable this only when it's actually needed.
1 parent aadcca4 commit 3770798

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

cmake-init/templates/common/CMakeUserPresets.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
"name": "dev",
1111
"inherits": ["ci-%(os)s"{if use_clang_tidy}, "clang-tidy"{end}{if use_cppcheck}, "cppcheck"{end}],
1212
"cacheVariables": {
13-
"%(name)s_DEVELOPER_MODE": "ON"
13+
"%(name)s_DEVELOPER_MODE": "ON",
14+
"BUILD_DOCUMENTATION": "ON"
1415
}
1516
}
1617
]

cmake-init/templates/executable/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ add_custom_target(
7070
VERBATIM
7171
)
7272

73-
option(BUILD_DOCUMENTATION "Build documentation using Doxygen and m.css" ON)
73+
option(BUILD_DOCUMENTATION "Build documentation using Doxygen and m.css" OFF)
7474
if(BUILD_DOCUMENTATION)
7575
include(cmake/docs.cmake)
7676
endif()

cmake-init/templates/header/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ if(BUILD_EXAMPLES)
5757
add_subdirectory(example)
5858
endif(){end}
5959

60-
option(BUILD_DOCUMENTATION "Build documentation using Doxygen and m.css" ON)
60+
option(BUILD_DOCUMENTATION "Build documentation using Doxygen and m.css" OFF)
6161
if(BUILD_DOCUMENTATION)
6262
include(cmake/docs.cmake)
6363
endif()

cmake-init/templates/shared/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ if(BUILD_EXAMPLES)
7878
add_subdirectory(example)
7979
endif(){end}
8080

81-
option(BUILD_DOCUMENTATION "Build documentation using Doxygen and m.css" ON)
81+
option(BUILD_DOCUMENTATION "Build documentation using Doxygen and m.css" OFF)
8282
if(BUILD_DOCUMENTATION)
8383
include(cmake/docs.cmake)
8484
endif()

0 commit comments

Comments
 (0)