summaryrefslogtreecommitdiffstats
path: root/documentation/conf.py
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@theobroma-systems.com>2022-07-05 11:42:12 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-07-06 10:33:25 +0100
commitfdb422c265af8b4966712e5492358c446eb3ef2d (patch)
tree8fe9829a7f61846600673b405275a1afafda4f35 /documentation/conf.py
parentbc6d96e69684253a7236594cb0af2738be06b7a9 (diff)
downloadpoky-fdb422c265af8b4966712e5492358c446eb3ef2d.tar.gz
docs: conf.py: bump minimum Sphinx version requirement
extlinks captions support using %s substitution but only from sphinx 4.0 onwards. Anything before does not support the %s substitution. However, this will be a requirement in sphinx 6.0 and later, and sphinx 5.0 already shows a warning telling us that. Since the build is made with -W flag which fails it if any warning is printed, a fix is required. Sphinx 4.0.0 was released two years ago. Unfortunately, Debian packages are out-of-date and only the latest Ubuntu has recent enough packages. Therefore, pip installation should be recommended now instead and the minimum version for building the docs bumped to 4.0. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: ab45a7a40484a2d8e604cb45549037c526ec61cb) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/conf.py')
-rw-r--r--documentation/conf.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index baf550e3e3..8a9cbc972e 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -53,7 +53,7 @@ author = 'The Linux Foundation'
53# -- General configuration --------------------------------------------------- 53# -- General configuration ---------------------------------------------------
54 54
55# Prevent building with an outdated version of sphinx 55# Prevent building with an outdated version of sphinx
56needs_sphinx = "3.1" 56needs_sphinx = "4.0"
57 57
58# to load local extension from the folder 'sphinx' 58# to load local extension from the folder 'sphinx'
59sys.path.insert(0, os.path.abspath('sphinx')) 59sys.path.insert(0, os.path.abspath('sphinx'))