diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2016-11-11 19:37:14 +0900 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2016-11-16 12:06:22 +0900 |
commit | 0d1875e2b5458e0f1f12aa4bfa538ca9c27fb908 (patch) | |
tree | edc4f0833716827a002cb38c135946f52e00adf9 /sphinx/ext/linkcode.py | |
parent | 23b1c3d5f203972d1d7a254594f0e7ca4baf7b59 (diff) | |
download | sphinx-git-0d1875e2b5458e0f1f12aa4bfa538ca9c27fb908.tar.gz |
Add type-check annotations to sphinx.ext
Diffstat (limited to 'sphinx/ext/linkcode.py')
-rw-r--r-- | sphinx/ext/linkcode.py | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index 63bd38727..a9693299e 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -16,12 +16,18 @@ from sphinx import addnodes from sphinx.locale import _ from sphinx.errors import SphinxError +if False: + # For type annotation + from typing import Any # NOQA + from sphinx.application import Sphinx # NOQA + class LinkcodeError(SphinxError): category = "linkcode error" def doctree_read(app, doctree): + # type: (Sphinx, nodes.Node) -> None env = app.builder.env resolve_target = getattr(env.config, 'linkcode_resolve', None) @@ -38,7 +44,7 @@ def doctree_read(app, doctree): for objnode in doctree.traverse(addnodes.desc): domain = objnode.get('domain') - uris = set() + uris = set() # type: Set[unicode] for signode in objnode: if not isinstance(signode, addnodes.desc_signature): continue @@ -72,6 +78,7 @@ def doctree_read(app, doctree): def setup(app): + # type: (Sphinx) -> Dict[unicode, Any] app.connect('doctree-read', doctree_read) app.add_config_value('linkcode_resolve', None, '') return {'version': sphinx.__display_version__, 'parallel_read_safe': True} |