summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorgeorg.brandl <devnull@localhost>2008-05-04 09:07:51 +0000
committergeorg.brandl <devnull@localhost>2008-05-04 09:07:51 +0000
commit5c61cc86bdf9473ae13eaa96c2bb1e254b50de4f (patch)
tree43e43dfbc4cae5e51676962b2489e8eec16230e0 /doc
parentfeab7c0abad015eec2b638851e87c708391a4756 (diff)
downloadsphinx-5c61cc86bdf9473ae13eaa96c2bb1e254b50de4f.tar.gz
#2656: autodoc now skips inherited members unless the :inherited-members: flag is given.
Diffstat (limited to 'doc')
-rw-r--r--doc/ext/autodoc.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst
index 1c8d36dd..5160cd8b 100644
--- a/doc/ext/autodoc.rst
+++ b/doc/ext/autodoc.rst
@@ -63,6 +63,10 @@ directive.
Members without docstrings will be left out, unless you give the
``undoc-members`` flag option.
+ .. versionadded:: 0.2.1
+ For classes and exceptions, members inherited from base classes will be
+ left out, unless you give the ``inherited-members`` flag option.
+
The "auto" directives can also contain content of their own, it will be
inserted into the resulting non-auto directive source after the docstring
(but before any automatic member documentation).