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

Address comments

Browse Source
This commit is contained in:
Alex Sergeev 2019-04-14 10:47:50 -10:00
parent 4bad5bd419
commit 98691baf85
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -359,8 +359,8 @@ There are also config values that you can set:
This value is a list of autodoc directive flags that should be automatically This value is a list of autodoc directive flags that should be automatically
applied to all autodoc directives. The supported flags are ``'members'``, applied to all autodoc directives. The supported flags are ``'members'``,
``'undoc-members'``, ``'private-members'``, ``'special-members'``, ``'undoc-members'``, ``'private-members'``, ``'special-members'``,
``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'``
``'imported-members'`` and ``'exclude-members'``. and ``'exclude-members'``.
.. versionadded:: 1.0 .. versionadded:: 1.0
@ -387,14 +387,17 @@ There are also config values that you can set:
The supported options are ``'members'``, ``'member-order'``, The supported options are ``'members'``, ``'member-order'``,
``'undoc-members'``, ``'private-members'``, ``'special-members'``, ``'undoc-members'``, ``'private-members'``, ``'special-members'``,
``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and ``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'``,
``'exclude-members'``. ``'imported-members'`` and ``'exclude-members'``.
.. versionadded:: 1.8 .. versionadded:: 1.8
.. versionchanged:: 2.0 .. versionchanged:: 2.0
Accepts ``True`` as a value. Accepts ``True`` as a value.
.. versionchanged:: 2.1
Added ``'imported-members'``.
.. confval:: autodoc_docstring_signature .. confval:: autodoc_docstring_signature
Functions imported from C modules cannot be introspected, and therefore the Functions imported from C modules cannot be introspected, and therefore the