summaryrefslogtreecommitdiff
path: root/sphinx/util/docutils.py
diff options
context:
space:
mode:
authorjfbu <jfbu@free.fr>2019-08-01 17:49:24 +0200
committerjfbu <jfbu@free.fr>2019-08-01 17:49:24 +0200
commit685e3fdb49c42b464e09ec955e1033e2a8729fff (patch)
treea7ad90fbd9c2a076575f612caf0d6baa7c4fb555 /sphinx/util/docutils.py
parenteeca5ee91d2da817d4ad9e920ad7e4cabd966d08 (diff)
parent5a86a71a8fe6d4e8c3861f755cc9b05b5b10f0cf (diff)
downloadsphinx-git-685e3fdb49c42b464e09ec955e1033e2a8729fff.tar.gz
Merge branch '2.0'
Diffstat (limited to 'sphinx/util/docutils.py')
-rw-r--r--sphinx/util/docutils.py15
1 files changed, 8 insertions, 7 deletions
diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py
index 66fcc3374..cef4dbce1 100644
--- a/sphinx/util/docutils.py
+++ b/sphinx/util/docutils.py
@@ -15,7 +15,7 @@ from copy import copy
from distutils.version import LooseVersion
from os import path
from types import ModuleType
-from typing import Any, Callable, Dict, Generator, IO, List, Optional, Set, Tuple, Type
+from typing import Any, Callable, Dict, Generator, IO, List, Optional, Set, Tuple
from typing import cast
import docutils
@@ -36,6 +36,7 @@ report_re = re.compile('^(.+?:(?:\\d+)?): \\((DEBUG|INFO|WARNING|ERROR|SEVERE)/(
if False:
# For type annotation
+ from typing import Type # for python3.5.1
from sphinx.builders import Builder
from sphinx.config import Config
from sphinx.environment import BuildEnvironment
@@ -67,7 +68,7 @@ def is_directive_registered(name: str) -> bool:
return name in directives._directives
-def register_directive(name: str, directive: Type[Directive]) -> None:
+def register_directive(name: str, directive: "Type[Directive]") -> None:
"""Register a directive to docutils.
This modifies global state of docutils. So it is better to use this
@@ -95,12 +96,12 @@ def unregister_role(name: str) -> None:
roles._roles.pop(name, None)
-def is_node_registered(node: Type[Element]) -> bool:
+def is_node_registered(node: "Type[Element]") -> bool:
"""Check the *node* is already registered."""
return hasattr(nodes.GenericNodeVisitor, 'visit_' + node.__name__)
-def register_node(node: Type[Element]) -> None:
+def register_node(node: "Type[Element]") -> None:
"""Register a node to docutils.
This modifies global state of some visitors. So it is better to use this
@@ -111,7 +112,7 @@ def register_node(node: Type[Element]) -> None:
additional_nodes.add(node)
-def unregister_node(node: Type[Element]) -> None:
+def unregister_node(node: "Type[Element]") -> None:
"""Unregister a node from docutils.
This is inverse of ``nodes._add_nodes_class_names()``.
@@ -182,7 +183,7 @@ class sphinx_domains:
def __enter__(self) -> None:
self.enable()
- def __exit__(self, exc_type: Type[Exception], exc_value: Exception, traceback: Any) -> bool: # NOQA
+ def __exit__(self, exc_type: "Type[Exception]", exc_value: Exception, traceback: Any) -> bool: # NOQA
self.disable()
return False
@@ -225,7 +226,7 @@ class sphinx_domains:
raise ElementLookupError
- def lookup_directive(self, directive_name: str, language_module: ModuleType, document: nodes.document) -> Tuple[Optional[Type[Directive]], List[system_message]]: # NOQA
+ def lookup_directive(self, directive_name: str, language_module: ModuleType, document: nodes.document) -> Tuple[Optional["Type[Directive]"], List[system_message]]: # NOQA
try:
return self.lookup_domain_element('directive', directive_name)
except ElementLookupError: