Merge topic 'doc-sphinx-2.x'

1f39a3cd1a Utilities/Sphinx: Restore explicit check for Sphinx 2.x or later
5de805bea2 Utilities/Sphinx: Fix flake8 E124 diagnostic in cmake.py

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8555
This commit is contained in:
Brad King
2023-06-13 14:48:24 +00:00
committed by Kitware Robot
2 changed files with 9 additions and 4 deletions

3
Utilities/Sphinx/.flake8 Normal file
View File

@@ -0,0 +1,3 @@
[flake8]
per-file-ignores =
cmake.py: E402

View File

@@ -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.
@@ -514,7 +516,7 @@ class CMakeReferenceRole:
class Class(parent):
def __call__(self, name: str, rawtext: str, text: str,
*args, **kwargs
) -> Tuple[List[Node], List[system_message]]:
) -> Tuple[List[Node], List[system_message]]:
text = CMakeReferenceRole._escape_angle_brackets(text)
return super().__call__(name, rawtext, text, *args, **kwargs)
return Class