summaryrefslogtreecommitdiff
path: root/sphinx/ext/linkcode.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2019-07-01 01:20:00 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2019-07-01 01:20:00 +0900
commitd85f52af439911a0d1e7e7c5e0871d1f664c8d72 (patch)
treee85a09fc047f0d8b2fee6aaf26c3b26e7fe3fe36 /sphinx/ext/linkcode.py
parent75477633b69b11858ae27c27f3af6e3ff2db928f (diff)
parente25d77e99931d7258506e463b73f0217b6bb9db5 (diff)
downloadsphinx-git-d85f52af439911a0d1e7e7c5e0871d1f664c8d72.tar.gz
Merge branch '2.0'
Diffstat (limited to 'sphinx/ext/linkcode.py')
-rw-r--r--sphinx/ext/linkcode.py15
1 files changed, 6 insertions, 9 deletions
diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py
index 3ebdf7bc9..e8635d926 100644
--- a/sphinx/ext/linkcode.py
+++ b/sphinx/ext/linkcode.py
@@ -8,25 +8,23 @@
:license: BSD, see LICENSE for details.
"""
+from typing import Any, Dict, Set
+
from docutils import nodes
+from docutils.nodes import Node
import sphinx
from sphinx import addnodes
+from sphinx.application import Sphinx
from sphinx.errors import SphinxError
from sphinx.locale import _
-if False:
- # For type annotation
- from typing import Any, Dict, Set # NOQA
- from sphinx.application import Sphinx # NOQA
-
class LinkcodeError(SphinxError):
category = "linkcode error"
-def doctree_read(app, doctree):
- # type: (Sphinx, nodes.Node) -> None
+def doctree_read(app: Sphinx, doctree: Node) -> None:
env = app.builder.env
resolve_target = getattr(env.config, 'linkcode_resolve', None)
@@ -75,8 +73,7 @@ def doctree_read(app, doctree):
signode += onlynode
-def setup(app):
- # type: (Sphinx) -> Dict[str, Any]
+def setup(app: Sphinx) -> Dict[str, Any]:
app.connect('doctree-read', doctree_read)
app.add_config_value('linkcode_resolve', None, '')
return {'version': sphinx.__display_version__, 'parallel_read_safe': True}