diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-08-02 01:26:05 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-08-02 01:27:14 +0900 |
| commit | d7a84e83ccde33ff7a1c770fa20b02bce82554d3 (patch) | |
| tree | dcdb09a15190c87390e5c1965ed4b8de43ff7a36 /doc/usage | |
| parent | 5e6da19f0e44a0ae83944fb6ce18f18f781e1a6e (diff) | |
| download | sphinx-git-d7a84e83ccde33ff7a1c770fa20b02bce82554d3.tar.gz | |
Close #8034: autodoc: :private-member: can take an list of member names
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
Diffstat (limited to 'doc/usage')
| -rw-r--r-- | doc/usage/extensions/autodoc.rst | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index 150b62c4d..71f49c240 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -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`. |