Add workflow to build docs

CaselIT · CaselIT · commit 63a3813f828d · 2023-04-23T21:41:05.000+02:00
Change-Id: I3f5ad6f3832ea56aba72c62f6bd2092288dcb5c9
diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml
@@ -0,0 +1,50 @@
+name: Build docs
+
+on:
+  # run on push in main or rel_* branches excluding changes are only on example folders
+  push:
+    branches:
+      - main
+      - "rel_*"
+      # branches used to test the workflow
+      - "workflow_test_*"
+    paths-ignore:
+      - "examples/**"
+
+permissions:
+  contents: read
+
+jobs:
+  run-test:
+    name: build-docs
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Set up python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install --requirement doc/build/requirements.txt
+          pip list
+
+      - name: Build docs
+        run: |
+          cd doc/build
+          make html
+
+      - name: Create artifact
+        run: |
+          tar czf docs.tgz doc/build/output/html
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs-archive
+          path: docs.tgz
