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

#5877: Allow setting imported_members for autosummary in conf.py

Browse Source
This commit is contained in:
tsanikgr
2019-03-27 13:48:26 +00:00
parent e1185ff2e4
commit bec116a3b6
7 changed files with 57 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/usage/extensions/autosummary.rst
View File

@@ -99,6 +99,12 @@ The :mod:`sphinx.ext.autosummary` extension does this in two parts:
.. versionadded:: 1.0
* You can specify to documented imported classes and functions at a module
level using the new :confval:`autosummary_imported_members` config value.
By default this if disabled.
.. versionadded:: 2.1.1
:program:`sphinx-autogen` -- generate autodoc stub pages
--------------------------------------------------------
@@ -149,6 +155,11 @@ also use these config values:
:confval:`autodoc_mock_imports` for more details. It defaults to
:confval:`autodoc_mock_imports`.
.. confval:: autosummary_imported_members
A boolean flag indicating whether to document classes and functions imported
in modules. Default is ``False``
Customizing templates
---------------------