diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-08-03 01:57:13 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-03 01:57:13 +0900 |
| commit | 57af8288826f9a37cb3ba3008fb36278ecbae81f (patch) | |
| tree | 09d7d7ebb01aedb6213e87525c638e8892f9400e /doc | |
| parent | 5be006124ed45e3fd5864c7feab15614f793d084 (diff) | |
| parent | d7a84e83ccde33ff7a1c770fa20b02bce82554d3 (diff) | |
| download | sphinx-git-57af8288826f9a37cb3ba3008fb36278ecbae81f.tar.gz | |
Merge pull request #8035 from tk0miya/8034_argument_for_private-members
Close #8034: autodoc: :private-member: can take an list of member names
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/extdev/deprecated.rst | 5 | ||||
| -rw-r--r-- | doc/usage/extensions/autodoc.rst | 15 |
2 files changed, 19 insertions, 1 deletions
diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst index ceb88d45f..d6e87b459 100644 --- a/doc/extdev/deprecated.rst +++ b/doc/extdev/deprecated.rst @@ -26,6 +26,11 @@ The following is a list of deprecated interfaces. - (will be) Removed - Alternatives + * - ``sphinx.ext.autodoc.merge_special_members_option()`` + - 3.2 + - 5.0 + - ``sphinx.ext.autodoc.merge_members_option()`` + * - ``sphinx.writers.texinfo.TexinfoWriter.desc`` - 3.2 - 5.0 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`. |