From c3b8e3fdf0085a6848dcaae5f3f112ef28025716 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 9 Sep 2009 18:26:59 +0200 Subject: [PATCH] Clarify docs of automodule options. --- doc/ext/autodoc.rst | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index bd1551add..f67b8a8a6 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -72,21 +72,27 @@ directive. * If you want to automatically document members, there's a ``members`` option:: + .. automodule:: noodle + :members: + + will document all module members (recursively), and + .. autoclass:: Noodle :members: will document all non-private member functions and properties (that is, - those whose name doesn't start with ``_``), while :: + those whose name doesn't start with ``_``). + + You can also give an explicit list of members; only these will then be + documented:: .. autoclass:: Noodle :members: eat, slurp - will document exactly the specified members. - * Members without docstrings will be left out, unless you give the ``undoc-members`` flag option:: - .. autoclass:: Noodle + .. automodule:: noodle :members: :undoc-members: @@ -141,11 +147,11 @@ directive. .. versionadded:: 0.6 - * The directives supporting member documentation also have a - ``exclude-members`` option that can be used to exclude single member names - from documentation, if all members are to be documented. + * The directives supporting member documentation also have a + ``exclude-members`` option that can be used to exclude single member names + from documentation, if all members are to be documented. - .. versionadded:: 0.6 + .. versionadded:: 0.6 .. note::