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 for auto directive options.

Browse Source
This commit is contained in:
Georg Brandl 2008-05-23 13:57:48 +00:00
parent 62b8028842
commit 0e3dd509e6
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/ext/autodoc.rst
View File

@ -61,17 +61,31 @@ directive.
will document exactly the specified members.
Members without docstrings will be left out, unless you give the
``undoc-members`` flag option.
``undoc-members`` flag option::
.. autoclass:: Noodle
:members:
:undoc-members:
.. versionadded:: 0.3
For classes and exceptions, members inherited from base classes will be
left out, unless you give the ``inherited-members`` flag option.
left out, unless you give the ``inherited-members`` flag option, in
addition to ``members``:
::
.. autoclass:: Noodle
:members:
:inherited-members:
This can be combined with ``undoc-members`` to document *all* available
members of the class or module.
.. versionadded:: 0.4
It's possible to override the signature for callable members (functions,
methods, classes) with the regular syntax that will override the signature
gained from instropection:
::
.. autoclass:: Noodle(type)