diff options
| author | georg.brandl <devnull@localhost> | 2008-06-22 17:58:05 +0000 |
|---|---|---|
| committer | georg.brandl <devnull@localhost> | 2008-06-22 17:58:05 +0000 |
| commit | 0f17731a67d97c2dc8e4b7245de88e7615eebeb6 (patch) | |
| tree | 027458ffd445d1f05ce49378000c42bbcccc0772 /doc | |
| parent | 4f2a051e116f650a451b6a83615034872d7b8b2a (diff) | |
| download | sphinx-0f17731a67d97c2dc8e4b7245de88e7615eebeb6.tar.gz | |
Support :noindex: in autodoc directives.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ext/autodoc.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index cf4dd561..50e9efc7 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -114,6 +114,13 @@ directive. .. versionadded:: 0.4 + * All autodoc directives support the ``noindex`` flag option that has the + same effect as for standard :dir:`function` etc. directives: no index + entries are generated for the documented object (and all autodocumented + members). + + .. versionadded:: 0.4 + .. note:: In an :dir:`automodule` directive with the ``members`` option set, only |