diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-12-26 01:26:52 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-12-26 01:26:52 +0900 |
| commit | f811e4cea696d1dd724f61fb7226b5187b69fac9 (patch) | |
| tree | b35400df3d95afdd5ae34ea376526095b5905b9e | |
| parent | b5c0edc9494627f8dd4c246a9d581096338e6af0 (diff) | |
| parent | 5b2befe97da2d2bccf4f2725854209f037f0623e (diff) | |
| download | sphinx-git-f811e4cea696d1dd724f61fb7226b5187b69fac9.tar.gz | |
Merge pull request #5859 from tk0miya/fix_doc_for_viewcode_follow_imported_members
doc: Fix description for viewcode_follow_imported_members
| -rw-r--r-- | doc/usage/extensions/viewcode.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/usage/extensions/viewcode.rst b/doc/usage/extensions/viewcode.rst index cc7dbb07a..d3c3c44fb 100644 --- a/doc/usage/extensions/viewcode.rst +++ b/doc/usage/extensions/viewcode.rst @@ -41,10 +41,9 @@ Configuration .. confval:: viewcode_follow_imported_members - If this is ``True``, viewcode extension will follow alias objects that - imported from another module such as functions, classes and attributes. As - side effects, this option else they produce nothing. The default is - ``True``. + If this is ``True``, viewcode extension will emit + :event:`viewcode-follow-imported` event to resolve the name of the module + by other extensions. The default is ``True``. .. versionadded:: 1.3 |