From 6330de68959d8377c1ef1a85716cebeaafa19d86 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ernst=20W=C3=BCrger?= <ernst.wuerger@deutschebahn.com>
Date: Tue, 24 Sep 2024 13:10:54 +0200
Subject: [PATCH] docs: Update workflow and try URL way for GIF in README

---
 .github/workflows/docs.yml | 19 +++++++++++++++----
 README.md                  |  2 +-
 2 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 62b41a8d..024fae6f 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -4,8 +4,10 @@
 name: Docs
 
 on:
+  pull_request:
   push:
     branches: ["main"]
+  workflow_dispatch:
 
 jobs:
   sphinx:
@@ -18,6 +20,8 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v5
         with:
+          cache: pip
+          cache-dependency-path: pyproject.toml
           python-version: "3.12"
       - name: Upgrade pip
         run: |
@@ -26,11 +30,18 @@ jobs:
         run: |
           python -m pip install '.[docs]'
       - name: Auto-generate APIDOC sources
-        run: |-
-          sphinx-apidoc --output-dir docs/source/code --force .
+        run: make -C docs apidoc
       - name: Create docs
-        run: |
-          make -C docs html
+        env:
+          SPHINXOPTS: ${{ github.ref != 'refs/heads/master' && '-W' || '' }}
+        run: make -C docs html
+      - name: Upload built docs as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: Documentation
+          path: docs/build/html
+          if-no-files-found: error
+          retention-days: 5
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
diff --git a/README.md b/README.md
index 48436156..2d0b827a 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@
 
 Synchronise Capella models with Polarion projects.
 
-![image](docs/source/_static/c2p-uc1.gif)
+![image](https://github.com/DSD-DBS/capella-polarion/blob/gh-pages/_static/c2p-uc1.GIF)
 
 Use cases covered: