mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Clarify docs of automodule options.
This commit is contained in:
parent
0899e017a9
commit
c3b8e3fdf0
@ -72,21 +72,27 @@ directive.
|
|||||||
* If you want to automatically document members, there's a ``members``
|
* If you want to automatically document members, there's a ``members``
|
||||||
option::
|
option::
|
||||||
|
|
||||||
|
.. automodule:: noodle
|
||||||
|
:members:
|
||||||
|
|
||||||
|
will document all module members (recursively), and
|
||||||
|
|
||||||
.. autoclass:: Noodle
|
.. autoclass:: Noodle
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
will document all non-private member functions and properties (that is,
|
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
|
.. autoclass:: Noodle
|
||||||
:members: eat, slurp
|
:members: eat, slurp
|
||||||
|
|
||||||
will document exactly the specified members.
|
|
||||||
|
|
||||||
* Members without docstrings will be left out, unless you give the
|
* Members without docstrings will be left out, unless you give the
|
||||||
``undoc-members`` flag option::
|
``undoc-members`` flag option::
|
||||||
|
|
||||||
.. autoclass:: Noodle
|
.. automodule:: noodle
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
|
|
||||||
@ -141,11 +147,11 @@ directive.
|
|||||||
|
|
||||||
.. versionadded:: 0.6
|
.. versionadded:: 0.6
|
||||||
|
|
||||||
* The directives supporting member documentation also have a
|
* The directives supporting member documentation also have a
|
||||||
``exclude-members`` option that can be used to exclude single member names
|
``exclude-members`` option that can be used to exclude single member names
|
||||||
from documentation, if all members are to be documented.
|
from documentation, if all members are to be documented.
|
||||||
|
|
||||||
.. versionadded:: 0.6
|
.. versionadded:: 0.6
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user