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

Close #8107: autodoc: Add class-doc-from option to autoclass directive

Browse Source 
Add `class-doc-from` option to the `autoclass` directive to control
the content of the specific class.  It takes `class`, `init`, and `both`
like `autoclass_content`.
This commit is contained in:
Takeshi KOMIYA
2021-05-01 14:50:46 +09:00
parent d656acaba3
commit d8a9f243e2
5 changed files with 71 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -343,6 +343,10 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
.. autoclass:: module.name::Noodle
* :rst:dir:`autoclass` also recognizes the ``class-doc-from`` option that
can be used to override the global value of :confval:`autoclass_content`.
.. versionadded:: 4.1
.. rst:directive:: autofunction
autodecorator
@@ -507,7 +511,7 @@ There are also config values that you can set:
The supported options are ``'members'``, ``'member-order'``,
``'undoc-members'``, ``'private-members'``, ``'special-members'``,
``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'``,
``'imported-members'`` and ``'exclude-members'``.
``'imported-members'``, ``'exclude-members'`` and ``'class-doc-from'``.
.. versionadded:: 1.8
@@ -517,6 +521,9 @@ There are also config values that you can set:
.. versionchanged:: 2.1
Added ``'imported-members'``.
.. versionchanged:: 4.1
Added ``'class-doc-from'``.
.. confval:: autodoc_docstring_signature
Functions imported from C modules cannot be introspected, and therefore the