diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2019-06-09 01:27:34 +0900 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2019-06-09 01:27:34 +0900 |
commit | 9f470cec6c943a9437dac2c09ea796e78e08156d (patch) | |
tree | 31e26a9be046f8b2e7499a93db1a5ee8dd6d4c3a /sphinx/util/compat.py | |
parent | 5ce5c2c3156c53c1f1b758c38150e48080138b15 (diff) | |
parent | 5cabe8be35ee44ca9a9ddaf5d93e2dd9f62abdc9 (diff) | |
download | sphinx-git-9f470cec6c943a9437dac2c09ea796e78e08156d.tar.gz |
Merge branch '2.0'
Diffstat (limited to 'sphinx/util/compat.py')
-rw-r--r-- | sphinx/util/compat.py | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 805c17e5d..340dd77fa 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -10,22 +10,21 @@ import sys import warnings +from typing import Any, Dict from docutils.utils import get_source_line from sphinx import addnodes +from sphinx.config import Config from sphinx.deprecation import RemovedInSphinx40Warning from sphinx.transforms import SphinxTransform if False: # For type annotation - from typing import Any, Dict # NOQA - from sphinx.application import Sphinx # NOQA - from sphinx.config import Config # NOQA + from sphinx.application import Sphinx -def register_application_for_autosummary(app): - # type: (Sphinx) -> None +def register_application_for_autosummary(app: "Sphinx") -> None: """Register application object to autosummary module. Since Sphinx-1.7, documenters and attrgetters are registered into @@ -42,8 +41,7 @@ class IndexEntriesMigrator(SphinxTransform): """Migrating indexentries from old style (4columns) to new style (5columns).""" default_priority = 700 - def apply(self, **kwargs): - # type: (Any) -> None + def apply(self, **kwargs) -> None: for node in self.document.traverse(addnodes.index): for i, entries in enumerate(node['entries']): if len(entries) == 4: @@ -53,8 +51,7 @@ class IndexEntriesMigrator(SphinxTransform): node['entries'][i] = entries + (None,) -def setup(app): - # type: (Sphinx) -> Dict[str, Any] +def setup(app: "Sphinx") -> Dict[str, Any]: app.add_transform(IndexEntriesMigrator) app.connect('builder-inited', register_application_for_autosummary) |