IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Plugins can resolve imported members for viewcode

Browse Source
This commit is contained in:
Ashley Whetter
2018-08-13 15:33:49 -07:00
parent f77216c5a6
commit 97164faec3
2 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/usage/extensions/viewcode.rst
View File

@@ -25,7 +25,11 @@ from the source to the description will also be inserted.
In addition, if you don't want to import the modules by ``viewcode``, In addition, if you don't want to import the modules by ``viewcode``,
you can tell the location of the location of source code to ``viewcode`` you can tell the location of the location of source code to ``viewcode``
using :event:`viewcode-find-source` event. using the :event:`viewcode-find-source` event.
If :confval:`viewcode_follow_imported_members` is enabled,
you will also need to resolve imported attributes
using the :event:`viewcode-follow-imported` event.
This extension works only on HTML related builders like ``html``, This extension works only on HTML related builders like ``html``,
``applehelp``, ``devhelp``, ``htmlhelp``, ``qthelp`` and so on except ``applehelp``, ``devhelp``, ``htmlhelp``, ``qthelp`` and so on except
@@ -83,3 +87,13 @@ Configuration
:param app: The Sphinx application object. :param app: The Sphinx application object.
:param modname: The name of the module to find source code for. :param modname: The name of the module to find source code for.
.. event:: viewcode-follow-imported (app, modname, attribute)
.. versionadded:: 1.8
Find the name of the original module for an attribute.
:param app: The Sphinx application object.
:param modname: The name of the module that the attribute belongs to.
:param attribute: The name of the member to follow.

8
sphinx/ext/viewcode.py
View File

@@ -104,7 +104,12 @@ def doctree_read(app, doctree):
fullname = signode.get('fullname') fullname = signode.get('fullname')
refname = modname refname = modname
if env.config.viewcode_follow_imported_members: if env.config.viewcode_follow_imported_members:
modname = _get_full_modname(app, modname, fullname) new_modname = app.emit_firstresult(
'viewcode-follow-imported', modname, fullname,
)
if not new_modname:
new_modname = _get_full_modname(app, modname, fullname)
modname = new_modname
if not modname: if not modname:
continue continue
fullname = signode.get('fullname') fullname = signode.get('fullname')
@@ -262,6 +267,7 @@ def setup(app):
# app.add_config_value('viewcode_include_modules', [], 'env') # app.add_config_value('viewcode_include_modules', [], 'env')
# app.add_config_value('viewcode_exclude_modules', [], 'env') # app.add_config_value('viewcode_exclude_modules', [], 'env')
app.add_event('viewcode-find-source') app.add_event('viewcode-find-source')
app.add_event('viewcode-follow-imported')
return { return {
'version': sphinx.__display_version__, 'version': sphinx.__display_version__,
'env_version': 1, 'env_version': 1,