Add instructions to build documentation
This enables documentation building in add-ons and other modules that need to build docs. Task-number: QTQAINFRA-3972 Change-Id: Ic2763d6d36d26e5a1267b312727c3c268ad6d114 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit e84e85dd4c59f2c79f81ba4d8d7f04397eb0003c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
parent
916c2953b1
commit
ddef86babf
41
coin/instructions/cmake_documentation_build.yaml
Normal file
41
coin/instructions/cmake_documentation_build.yaml
Normal file
@ -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
|
@ -5,6 +5,7 @@ instructions:
|
|||||||
instructions:
|
instructions:
|
||||||
- !include "{{qt/qtbase}}/cmake_module_build_instructions.yaml"
|
- !include "{{qt/qtbase}}/cmake_module_build_instructions.yaml"
|
||||||
- !include "{{qt/qtbase}}/cmake_build_and_upload_test_artifacts_host.yaml"
|
- !include "{{qt/qtbase}}/cmake_build_and_upload_test_artifacts_host.yaml"
|
||||||
|
- !include "{{qt/qtbase}}/cmake_documentation_build.yaml"
|
||||||
enable_if:
|
enable_if:
|
||||||
condition: and
|
condition: and
|
||||||
conditions:
|
conditions:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user