Add BUILD_DOCS option to enable/disable building documentation. #2730
Conversation
| @@ -17,6 +17,7 @@ option(DISABLE_DOWNLOADS "Disable downloads of dependencies during build." OFF) | |||
| option(DOWNLOAD_ENSMALLEN "If ensmallen is not found, download it." ON) | |||
| option(DOWNLOAD_STB_IMAGE "Download stb_image for image loading." ON) | |||
| option(BUILD_GO_SHLIB "Build Go shared library." OFF) | |||
| option(BUILD_DOCS "Build doxygen documentation (if doxygen is available)." ON) | |||
There was a problem hiding this comment.
Wondering if the default should be OFF, or if not if we should set WARN_AS_ERROR = NO as default? Until they take a look at: doxygen/doxygen#7818
There was a problem hiding this comment.
Yeah, good point, let's set WARN_AS_ERROR to NO by default, but then sed it to ON in the Doxygen build.
|
I use the PR to check if the static analysis job works as expected, turns out the pvs tool expects that |
|
@mlpack-jenkins test this please |
Looks like the format of the output format changed as well, let's see if I fixed it; for some reason the cppcheck jenkins report plugin expects a closing |
|
@mlpack-jenkins test this please |
This just adds a
BUILD_DOCSoption to the CMake configuration. Now, if someone is having Doxygen issues, they can disable that from the build by setting-DBUILD_DOCS=OFF. I also updated documentation so that people can know that the option exists.This is necessary as part of getting Jenkins working correctly again for the Doxygen build and other builds.