diff options
author | Yoann Congal <yoann.congal@smile.fr> | 2021-01-18 12:37:35 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-20 00:53:53 +0000 |
commit | 164db40a728876f75e0dc8188c943bc17afd542d (patch) | |
tree | 3685f61cff9e79ff09b06d5c5abf5f3658783eb0 /documentation/conf.py | |
parent | d8698dc755e00426698b479d0dd023e35eeececb (diff) | |
download | poky-164db40a728876f75e0dc8188c943bc17afd542d.tar.gz |
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 <yoann.congal@smile.fr>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/conf.py')
-rw-r--r-- | documentation/conf.py | 3 |
1 files changed, 3 insertions, 0 deletions
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' | |||
33 | 33 | ||
34 | # -- General configuration --------------------------------------------------- | 34 | # -- General configuration --------------------------------------------------- |
35 | 35 | ||
36 | # Prevent building with an outdated version of sphinx | ||
37 | needs_sphinx = "3.1" | ||
38 | |||
36 | # to load local extension from the folder 'sphinx' | 39 | # to load local extension from the folder 'sphinx' |
37 | sys.path.insert(0, os.path.abspath('sphinx')) | 40 | sys.path.insert(0, os.path.abspath('sphinx')) |
38 | 41 | ||