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

Support :noindex: in autodoc directives.

Browse Source
This commit is contained in:
Georg Brandl 2008-06-22 17:58:05 +00:00
parent aad1af62e9
commit 7c2247f880
3 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -72,6 +72,8 @@ New features added
- The `autodoc` extension now offers a ``show-inheritance`` option - The `autodoc` extension now offers a ``show-inheritance`` option
for autoclass that inserts a list of bases after the signature. for autoclass that inserts a list of bases after the signature.
- The autodoc directives now support the ``noindex`` flag option.
Bugs fixed Bugs fixed
---------- ----------

7
doc/ext/autodoc.rst
View File

@ -114,6 +114,13 @@ directive.
.. versionadded:: 0.4 .. 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:: .. note::
In an :dir:`automodule` directive with the ``members`` option set, only In an :dir:`automodule` directive with the ``members`` option set, only

17
sphinx/ext/autodoc.py
View File

@ -314,6 +314,8 @@ def generate_rst(what, name, members, options, add_content, document, lineno,
# Be explicit about the module, this is necessary since .. class:: doesn't # Be explicit about the module, this is necessary since .. class:: doesn't
# support a prepended module name # support a prepended module name
result.append(indent + u' :module: %s' % mod, '<autodoc>') result.append(indent + u' :module: %s' % mod, '<autodoc>')
if options.noindex:
result.append(indent + u' :noindex:', '<autodoc>')
result.append(u'', '<autodoc>') result.append(u'', '<autodoc>')
if options.show_inheritance and what in ('class', 'exception'): if options.show_inheritance and what in ('class', 'exception'):
@ -424,6 +426,7 @@ def _auto_directive(dirname, arguments, options, content, lineno,
members = ['__all__'] members = ['__all__']
genopt.undoc = 'undoc-members' in options genopt.undoc = 'undoc-members' in options
genopt.show_inheritance = 'show-inheritance' in options genopt.show_inheritance = 'show-inheritance' in options
genopt.noindex = 'noindex' in options
filename_set = set() filename_set = set()
warnings, result = generate_rst(what, name, members, genopt, content, state.document, warnings, result = generate_rst(what, name, members, genopt, content, state.document,
@ -469,9 +472,10 @@ def members_directive(arg):
def setup(app): def setup(app):
mod_options = {'members': members_directive, 'undoc-members': directives.flag} mod_options = {'members': members_directive, 'undoc-members': directives.flag,
'noindex': directives.flag}
cls_options = {'members': members_directive, 'undoc-members': directives.flag, cls_options = {'members': members_directive, 'undoc-members': directives.flag,
'inherited-members': directives.flag, 'noindex': directives.flag, 'inherited-members': directives.flag,
'show-inheritance': directives.flag} 'show-inheritance': directives.flag}
app.add_directive('automodule', auto_directive_withmembers, app.add_directive('automodule', auto_directive_withmembers,
1, (1, 0, 1), **mod_options) 1, (1, 0, 1), **mod_options)
@ -479,8 +483,11 @@ def setup(app):
1, (1, 0, 1), **cls_options) 1, (1, 0, 1), **cls_options)
app.add_directive('autoexception', auto_directive_withmembers, app.add_directive('autoexception', auto_directive_withmembers,
1, (1, 0, 1), **cls_options) 1, (1, 0, 1), **cls_options)
app.add_directive('autofunction', auto_directive, 1, (1, 0, 1)) app.add_directive('autofunction', auto_directive, 1, (1, 0, 1)
app.add_directive('automethod', auto_directive, 1, (1, 0, 1)) noindex=directives.flag)
app.add_directive('autoattribute', auto_directive, 1, (1, 0, 1)) app.add_directive('automethod', auto_directive, 1, (1, 0, 1),
noindex=directives.flag)
app.add_directive('autoattribute', auto_directive, 1, (1, 0, 1),
noindex=directives.flag)
app.add_config_value('automodule_skip_lines', 0, True) app.add_config_value('automodule_skip_lines', 0, True)
app.add_config_value('autoclass_content', 'class', True) app.add_config_value('autoclass_content', 'class', True)