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

Clarify docs of automodule options.

Browse Source
This commit is contained in:
Georg Brandl 2009-09-09 18:26:59 +02:00
parent 0899e017a9
commit c3b8e3fdf0
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/ext/autodoc.rst
View File

@ -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::