mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
merge with 0.6
This commit is contained in:
commit
b51ed6d25d
@ -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:
|
||||
|
||||
@ -101,6 +107,9 @@ directive.
|
||||
This can be combined with ``undoc-members`` to document *all* available
|
||||
members of the class or module.
|
||||
|
||||
Note: this will lead to markup errors if the inherited members come from a
|
||||
module whose docstrings are not reST formatted.
|
||||
|
||||
.. versionadded:: 0.3
|
||||
|
||||
* It's possible to override the signature for explicitly documented callable
|
||||
|
Loading…
Reference in New Issue
Block a user