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 #8034: autodoc: :private-member: can take an list of member names

Browse Source 
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
This commit is contained in:
Takeshi KOMIYA
2020-08-02 01:26:05 +09:00
parent 5e6da19f0e
commit d7a84e83cc
5 changed files with 80 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -136,9 +136,22 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
:undoc-members:
* "Private" members (that is, those named like ``_private`` or ``__private``)
will be included if the ``private-members`` flag option is given.
will be included if the ``private-members`` flag option is given::
.. automodule:: noodle
:members:
:private-members:
It can also take an explicit list of member names to be documented as
arguments::
.. automodule:: noodle
:members:
:private-members: _spicy, _garlickly
.. versionadded:: 1.1
.. versionchanged:: 3.2
The option can now take arguments.
* autodoc considers a member private if its docstring contains
``:meta private:`` in its :ref:`info-field-lists`.