documentation: Prevent building documentation with an outdated version of sphinx

Submitted by Yoann Congal on Jan. 18, 2021, 11:37 a.m. | Patch ID: 179193

Details

Message ID 20210118113735.30131-1-yoann.congal@smile.fr
State New
Headers show

Commit Message

Yoann Congal Jan. 18, 2021, 11:37 a.m.
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

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
---
 documentation/conf.py | 3 +++
 1 file changed, 3 insertions(+)

Patch hide | download patch | download mbox

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'))