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

Merge pull request #5859 from tk0miya/fix_doc_for_viewcode_follow_imported_members

Browse Source 
doc: Fix description for viewcode_follow_imported_members
This commit is contained in:
Takeshi KOMIYA
2018-12-26 01:26:52 +09:00
committed by GitHub
parent b5c0edc949 5b2befe97d
commit f811e4cea6
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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