summaryrefslogtreecommitdiff
path: root/sphinx/ext/viewcode.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2021-01-19 02:50:11 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2021-01-19 02:51:03 +0900
commit84150b2106f947d310960e7951ac0bea0eb36731 (patch)
tree3fa62a70ba95320dab976817bdf4f40add8d9063 /sphinx/ext/viewcode.py
parent40f2c832ff3ce2d908b0d8bace3e1f6698eed712 (diff)
downloadsphinx-git-84150b2106f947d310960e7951ac0bea0eb36731.tar.gz
refactor: viewcode: Fix type annotations
Diffstat (limited to 'sphinx/ext/viewcode.py')
-rw-r--r--sphinx/ext/viewcode.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py
index 89b97de02..a7d52a91c 100644
--- a/sphinx/ext/viewcode.py
+++ b/sphinx/ext/viewcode.py
@@ -11,7 +11,7 @@
import posixpath
import traceback
from os import path
-from typing import Any, Dict, Iterable, Iterator, Optional, Set, Tuple, cast
+from typing import Any, Dict, Generator, Iterable, Optional, Set, Tuple, cast
from docutils import nodes
from docutils.nodes import Element, Node
@@ -32,7 +32,7 @@ logger = logging.getLogger(__name__)
OUTPUT_DIRNAME = '_modules'
-def _get_full_modname(app: Sphinx, modname: str, attribute: str) -> str:
+def _get_full_modname(app: Sphinx, modname: str, attribute: str) -> Optional[str]:
try:
return get_full_modname(modname, attribute)
except AttributeError:
@@ -135,7 +135,7 @@ def env_merge_info(app: Sphinx, env: BuildEnvironment, docnames: Iterable[str],
def missing_reference(app: Sphinx, env: BuildEnvironment, node: Element, contnode: Node
- ) -> Node:
+ ) -> Optional[Node]:
# resolve our "viewcode" reference nodes -- they need special treatment
if node['reftype'] == 'viewcode':
return make_refnode(app.builder, node['refdoc'], node['reftarget'],
@@ -178,7 +178,7 @@ def should_generate_module_page(app: Sphinx, modname: str) -> bool:
return True
-def collect_pages(app: Sphinx) -> Iterator[Tuple[str, Dict[str, Any], str]]:
+def collect_pages(app: Sphinx) -> Generator[Tuple[str, Dict[str, Any], str], None, None]:
env = app.builder.env
if not hasattr(env, '_viewcode_modules'):
return