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

doc: Update document for autodoc :special-members: option

Browse Source
This commit is contained in:
Takeshi KOMIYA 2021-03-06 19:12:10 +09:00
parent 8411b9a536
commit 697fdea612
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -155,6 +155,28 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
.. versionchanged:: 3.2 .. versionchanged:: 3.2
The option can now take arguments. The option can now take arguments.
.. rst:directive:option:: special-members
:type: no value or comma separated list
If set, autodoc will also generate document for the special members
(that is, those named like ``__special__``)::
.. autoclass:: my.Class
:members:
:special-members:
It can also take an explicit list of member names to be documented as
arguments::
.. autoclass:: my.Class
:members:
:special-members: __init__, __name__
.. versionadded:: 1.1
.. versionchanged:: 1.2
The option can now take arguments
**Options and advanced usage** **Options and advanced usage**
* If you want to make the ``members`` option (or other options described * If you want to make the ``members`` option (or other options described
@ -219,21 +241,6 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
.. versionadded:: 3.5 .. versionadded:: 3.5
* Python "special" members (that is, those named like ``__special__``) will
be included if the ``special-members`` flag option is given::
.. autoclass:: my.Class
:members:
:private-members:
:special-members:
would document both "private" and "special" members of the class.
.. versionadded:: 1.1
.. versionchanged:: 1.2
The option can now take arguments, i.e. the special members to document.
* For classes and exceptions, members inherited from base classes will be * For classes and exceptions, members inherited from base classes will be
left out when documenting all members, unless you give the left out when documenting all members, unless you give the
``inherited-members`` option, in addition to ``members``:: ``inherited-members`` option, in addition to ``members``::