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

merge with 0.6

Browse Source
This commit is contained in:
Georg Brandl 2009-09-09 19:18:48 +02:00
commit b51ed6d25d
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/ext/autodoc.rst
View File

@ -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:
@ -101,6 +107,9 @@ directive.
This can be combined with ``undoc-members`` to document *all* available This can be combined with ``undoc-members`` to document *all* available
members of the class or module. 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 .. versionadded:: 0.3
* It's possible to override the signature for explicitly documented callable * It's possible to override the signature for explicitly documented callable
@ -141,11 +150,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::