summaryrefslogtreecommitdiff
path: root/sphinx/ext/viewcode.py
diff options
context:
space:
mode:
Diffstat (limited to 'sphinx/ext/viewcode.py')
-rw-r--r--sphinx/ext/viewcode.py19
1 files changed, 5 insertions, 14 deletions
diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py
index 82c2111ef..dc24a1993 100644
--- a/sphinx/ext/viewcode.py
+++ b/sphinx/ext/viewcode.py
@@ -9,7 +9,6 @@
"""
import traceback
-import warnings
from typing import Any, Dict, Iterable, Iterator, Set, Tuple
from docutils import nodes
@@ -18,8 +17,6 @@ from docutils.nodes import Element, Node
import sphinx
from sphinx import addnodes
from sphinx.application import Sphinx
-from sphinx.config import Config
-from sphinx.deprecation import RemovedInSphinx30Warning
from sphinx.environment import BuildEnvironment
from sphinx.locale import _, __
from sphinx.pycode import ModuleAnalyzer
@@ -57,10 +54,10 @@ def doctree_read(app: Sphinx, doctree: Node) -> None:
if app.builder.name.startswith("epub") and not env.config.viewcode_enable_epub:
return
- def has_tag(modname, fullname, docname, refname):
+ def has_tag(modname: str, fullname: str, docname: str, refname: str) -> bool:
entry = env._viewcode_modules.get(modname, None) # type: ignore
if entry is False:
- return
+ return False
code_tags = app.emit_firstresult('viewcode-find-source', modname)
if code_tags is None:
@@ -69,7 +66,7 @@ def doctree_read(app: Sphinx, doctree: Node) -> None:
analyzer.find_tags()
except Exception:
env._viewcode_modules[modname] = False # type: ignore
- return
+ return False
code = analyzer.code
tags = analyzer.tags
@@ -84,6 +81,8 @@ def doctree_read(app: Sphinx, doctree: Node) -> None:
used[fullname] = docname
return True
+ return False
+
for objnode in doctree.traverse(addnodes.desc):
if objnode.get('domain') != 'py':
continue
@@ -234,18 +233,10 @@ def collect_pages(app: Sphinx) -> Iterator[Tuple[str, Dict[str, Any], str]]:
yield ('_modules/index', context, 'page.html')
-def migrate_viewcode_import(app: Sphinx, config: Config) -> None:
- if config.viewcode_import is not None:
- warnings.warn('viewcode_import was renamed to viewcode_follow_imported_members. '
- 'Please update your configuration.',
- RemovedInSphinx30Warning, stacklevel=2)
-
-
def setup(app: Sphinx) -> Dict[str, Any]:
app.add_config_value('viewcode_import', None, False)
app.add_config_value('viewcode_enable_epub', False, False)
app.add_config_value('viewcode_follow_imported_members', True, False)
- app.connect('config-inited', migrate_viewcode_import)
app.connect('doctree-read', doctree_read)
app.connect('env-merge-info', env_merge_info)
app.connect('html-collect-pages', collect_pages)