summaryrefslogtreecommitdiffstats
path: root/Utilities
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-06-12 21:37:13 (GMT)
committerBrad King <brad.king@kitware.com>2023-06-12 21:37:13 (GMT)
commit1f39a3cd1a5b397d26cb9dfa1242573c1ee45143 (patch)
tree953ce569fdd6a0dbbc115b6916268f02f2beb33d /Utilities
parent5de805bea21af6c20f35afcbb925b1856d643bbe (diff)
downloadCMake-1f39a3cd1a5b397d26cb9dfa1242573c1ee45143.zip
CMake-1f39a3cd1a5b397d26cb9dfa1242573c1ee45143.tar.gz
CMake-1f39a3cd1a5b397d26cb9dfa1242573c1ee45143.tar.bz2
Utilities/Sphinx: Restore explicit check for Sphinx 2.x or later
Refactoring in commit adbc8c982d (Utilities/Sphinx: Fix flake8 gripes in cmake.py, 2023-03-13, v3.27.0-rc1~317^2) moved the assertion added by commit cef51925a4 (Utilities/Sphinx: Require Sphinx 2.x or later, 2023-03-13, v3.27.0-rc1~317^2~2) to after imports, which is too late to clearly reject older Sphinx versions.
Diffstat (limited to 'Utilities')
-rw-r--r--Utilities/Sphinx/.flake83
-rw-r--r--Utilities/Sphinx/cmake.py8
2 files changed, 8 insertions, 3 deletions
diff --git a/Utilities/Sphinx/.flake8 b/Utilities/Sphinx/.flake8
new file mode 100644
index 0000000..7218008
--- /dev/null
+++ b/Utilities/Sphinx/.flake8
@@ -0,0 +1,3 @@
+[flake8]
+per-file-ignores =
+ cmake.py: E402
diff --git a/Utilities/Sphinx/cmake.py b/Utilities/Sphinx/cmake.py
index faca2ed..d3eb948 100644
--- a/Utilities/Sphinx/cmake.py
+++ b/Utilities/Sphinx/cmake.py
@@ -11,6 +11,11 @@ from typing import Any, List, Tuple, Type, cast
import sphinx
+# Require at least Sphinx 2.x.
+# flake8 issues E402 for imports after this, but the purpose of this
+# check is to fail more clearly if the imports below will fail.
+assert sphinx.version_info >= (2,)
+
from docutils.utils.code_analyzer import Lexer, LexerError
from docutils.parsers.rst import Directive, directives
from docutils.transforms import Transform
@@ -110,9 +115,6 @@ CMakeLexer.tokens["root"] = [
# %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-# Require at least Sphinx 2.x.
-assert sphinx.version_info >= (2,)
-
logger = logging.getLogger(__name__)
# RE to split multiple command signatures.