diff mbox series

CI: add documentation job

Message ID 20221024125635.1988032-1-ross.burton@arm.com
State New
Headers show
Series CI: add documentation job | expand

Commit Message

Ross Burton Oct. 24, 2022, 12:56 p.m. UTC 
This job builds all of the Sphinx documentation it can find with fatal
warnings enabled.

Signed-off-by: Ross Burton <ross.burton@arm.com>
---
 .gitlab-ci.yml | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Jon Mason Oct. 24, 2022, 5:36 p.m. UTC | #1 
On Mon, 24 Oct 2022 13:56:35 +0100, Ross Burton wrote:
> This job builds all of the Sphinx documentation it can find with fatal
> warnings enabled.

Applied, thanks!

[1/1] CI: add documentation job
      commit: 72f0580f70e771432c83418e644d92e46dd33a58

Best regards,
diff mbox series

Patch

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 98a95c13..7d050a55 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -242,3 +242,18 @@  metrics:
   script:
     - kas shell --update --force-checkout ci/base.yml --command \
       "$CI_PROJECT_DIR/ci/patchreview $CI_PROJECT_DIR/meta-* --verbose --metrics $CI_PROJECT_DIR/metrics.txt"
+
+documentation:
+  extends: .setup
+  script:
+    - |
+      sudo pip3 install -r meta-arm-bsp/documentation/requirements.txt
+      for CONF in meta-*/documentation/*/conf.py ; do
+        SOURCE_DIR=$(dirname $CONF)
+        MACHINE=$(basename $SOURCE_DIR)
+        sphinx-build -vW $SOURCE_DIR build-docs/$MACHINE
+      done
+      test -d build-docs/
+  artifacts:
+    paths:
+      - build-docs/