From 7fd89ed63bad149212c2257c4ca8f344cf4e044f Mon Sep 17 00:00:00 2001
From: Toni Saario <toni.saario@qt.io>
Date: Tue, 27 Oct 2020 15:01:16 +0200
Subject: [PATCH] Add instructions to build documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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>
---
 .../cmake_documentation_build.yaml            | 41 +++++++++++++++++++
 .../coin_module_build_template_v2.yaml        |  1 +
 2 files changed, 42 insertions(+)
 create mode 100644 coin/instructions/cmake_documentation_build.yaml

diff --git a/coin/instructions/cmake_documentation_build.yaml b/coin/instructions/cmake_documentation_build.yaml
new file mode 100644
index 00000000000..d8ce9765ff4
--- /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
diff --git a/coin/instructions/coin_module_build_template_v2.yaml b/coin/instructions/coin_module_build_template_v2.yaml
index bee930d447d..09bdb25ef01 100644
--- a/coin/instructions/coin_module_build_template_v2.yaml
+++ b/coin/instructions/coin_module_build_template_v2.yaml
@@ -5,6 +5,7 @@ instructions:
     instructions:
       - !include "{{qt/qtbase}}/cmake_module_build_instructions.yaml"
       - !include "{{qt/qtbase}}/cmake_build_and_upload_test_artifacts_host.yaml"
+      - !include "{{qt/qtbase}}/cmake_documentation_build.yaml"
     enable_if:
       condition: and
       conditions: