From f7294e490cd8b50bce7d0bb312ca8aea56dc5074 Mon Sep 17 00:00:00 2001
From: Douglas Raillard <douglas.raillard@arm.com>
Date: Thu, 8 May 2025 11:28:05 +0100
Subject: [PATCH] doc: Add doc_constraints.txt

FIX

Add workaround for issue
https://github.com/sphinx-doc/sphinx/issues/13533 by adding a
constraints.txt file for doc builds.
---
 .gitlab-ci.yml          | 1 +
 doc/doc_constraints.txt | 3 +++
 tools/tests.sh          | 1 +
 3 files changed, 5 insertions(+)
 create mode 100644 doc/doc_constraints.txt

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 93f623c86..34e35f763 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -258,6 +258,7 @@ pages:
 
             set +e
             source ./init_env || return 1
+            lisa_python -m pip install -c ./doc/doc_constraints.txt
             set -e
             audit
 
diff --git a/doc/doc_constraints.txt b/doc/doc_constraints.txt
new file mode 100644
index 000000000..58a27d88b
--- /dev/null
+++ b/doc/doc_constraints.txt
@@ -0,0 +1,3 @@
+# Workaround for that issue:
+# https://github.com/sphinx-doc/sphinx/issues/13533
+snowballstemmer < 3
diff --git a/tools/tests.sh b/tools/tests.sh
index 20908e07a..31ddf6f1a 100755
--- a/tools/tests.sh
+++ b/tools/tests.sh
@@ -36,6 +36,7 @@ echo "Starting exekall self tests"
 exekall run "$LISA_HOME/tools/exekall/src/exekall/_tests"
 
 echo "Starting documentation pedantic build ..."
+"$LISA_PYTHON" -m pip install -c "$LISA_HOME/doc/doc_constraints.txt"
 lisa-doc-build
 
 MANPAGE_PYTHON_VERSION="3.11"
-- 
GitLab