From 009fd4c396e949c7ff2568dc02855763df3a078a Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 6 Mar 2021 19:08:23 +0900 Subject: [PATCH] doc: Update document for autodoc :undoc-members: option --- doc/usage/extensions/autodoc.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index b162683b7..c7a553c12 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -124,6 +124,16 @@ inserting them into the page source under a suitable :rst:dir:`py:module`, .. autoclass:: Noodle :members: eat, slurp + .. rst:directive:option:: undoc-members + :type: no value + + If set, autodoc will also generate document for the members not having + docstrings:: + + .. automodule:: noodle + :members: + :undoc-members: + **Options and advanced usage** * If you want to make the ``members`` option (or other options described @@ -149,13 +159,6 @@ inserting them into the page source under a suitable :rst:dir:`py:module`, .. versionchanged:: 3.5 The default options can be overridden or extended temporarily. - * Members without docstrings will be left out, unless you give the - ``undoc-members`` flag option:: - - .. automodule:: noodle - :members: - :undoc-members: - * "Private" members (that is, those named like ``_private`` or ``__private``) will be included if the ``private-members`` flag option is given::