From 164db40a728876f75e0dc8188c943bc17afd542d Mon Sep 17 00:00:00 2001 From: Yoann Congal Date: Mon, 18 Jan 2021 12:37:35 +0100 Subject: documentation: Prevent building documentation with an outdated version of sphinx Building with a outdated version of Sphinx print warnings that does not appear on up-to-date sphinx. This patch prevent building the documentation with any version older than 3.1 (First version to build without warnings in my tests) See threads "documentation: Add a simple Sphinx extension to check its version" https://lists.yoctoproject.org/g/docs/topic/patch_documentation_add_a/79919516 and "toaster-manual: Fix a warning related to the code-block directive" https://lists.yoctoproject.org/g/docs/topic/patch_toaster_manual_fix_a/79656195 (From yocto-docs rev: 4de0f3dd4d5df0a0700f704a599bb41726d15a5f) Signed-off-by: Yoann Congal Signed-off-by: Richard Purdie --- documentation/conf.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'documentation') diff --git a/documentation/conf.py b/documentation/conf.py index 407ea3292f..5a2e25f7b2 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -33,6 +33,9 @@ author = 'The Linux Foundation' # -- General configuration --------------------------------------------------- +# Prevent building with an outdated version of sphinx +needs_sphinx = "3.1" + # to load local extension from the folder 'sphinx' sys.path.insert(0, os.path.abspath('sphinx')) -- cgit v1.2.3-54-g00ecf