summaryrefslogtreecommitdiffstats
path: root/coin/instructions/cmake_documentation_build.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'coin/instructions/cmake_documentation_build.yaml')
-rw-r--r--coin/instructions/cmake_documentation_build.yaml41
1 files changed, 41 insertions, 0 deletions
diff --git a/coin/instructions/cmake_documentation_build.yaml b/coin/instructions/cmake_documentation_build.yaml
new file mode 100644
index 0000000000..d8ce9765ff
--- /dev/null
+++ b/coin/instructions/cmake_documentation_build.yaml
@@ -0,0 +1,41 @@
+type: Group
+instructions:
+ - type: MakeDirectory
+ directory: "{{.SourceDir}}_doc_build"
+ - type: SetBuildDirectory
+ directory: "{{.SourceDir}}_doc_build"
+ - type: ChangeDirectory
+ directory: "{{.BuildDir}}"
+ - type: ExecuteCommand
+ command: "rm {{.SourceDir}}/CMakeCache.txt" # CMake configure does not apply if not removed.
+ maxTimeInSeconds: 300
+ maxTimeBetweenOutput: 300
+ userMessageOnFailure: Failed to remove CMake cache.
+ - type: CreateFileListFromDirectory
+ directory: "{{.BuildDir}}/doc"
+ filterListFileName: "doc_build_filter"
+ userMessageOnFailure: "Failed to create filter list for docs"
+ - type: EnvironmentVariable
+ variableName: COIN_CMAKE_ARGS
+ variableValue: "-DCMAKE_INSTALL_PREFIX:PATH={{.InstallDir}} {{.SourceDir}}"
+ - !include "{{qt/qtbase}}/call_cmake.yaml"
+ - type: ExecuteCommand
+ command: "{{.Env.ENV_PREFIX}} cmake --build . --target generate_docs -v"
+ maxTimeInSeconds: 6000
+ maxTimeBetweenOutput: 1200
+ userMessageOnFailure: Failed to generate documentation.
+ - type: UploadArtifact
+ archiveDirectory: "{{.BuildDir}}/doc"
+ transferType: UploadModuleDocumentation
+ filterListFileName: "doc_build_filter"
+ maxTimeInSeconds: 1200
+ maxTimeBetweenOutput: 1200
+enable_if:
+ condition: and
+ conditions:
+ - condition: property
+ property: features
+ contains_value: Documentation
+ - condition: runtime
+ env_var: BUILD_DOCUMENTATION
+ not_equals_value: null