diff options
| author | Georg Brandl <georg@python.org> | 2008-12-15 12:49:40 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2008-12-15 12:49:40 +0100 |
| commit | bf841f36c1265a31ad82c1f8c4bceac238d3081f (patch) | |
| tree | b2b495675f48a3e1def1c94d841d0ce2614ce47e /tests | |
| parent | 3fe753f5452ff23031f3bc6440281a02bb83309d (diff) | |
| download | sphinx-bf841f36c1265a31ad82c1f8c4bceac238d3081f.tar.gz | |
The ``autodoc_skip_member`` event now also gets to decide
whether to skip members whose name starts with underscores.
Previously, these members were always automatically skipped.
Therefore, if you handle this event, add something like this
to your event handler to restore the old behavior::
if name.startswith('_'):
return True
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/test_autodoc.py | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index ee3fdf1d..746c9b42 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -24,6 +24,7 @@ def setup_module(): app.builder.env.app = app app.connect('autodoc-process-docstring', process_docstring) app.connect('autodoc-process-signature', process_signature) + app.connect('autodoc-skip-member', skip_member) options = Struct( inherited_members = False, @@ -71,6 +72,13 @@ def process_signature(app, what, name, obj, options, args, retann): return '42', None +def skip_member(app, what, name, obj, skip, options): + if name.startswith('_'): + return True + if name == 'skipmeth': + return True + + def test_resolve_name(): # for modules assert gen.resolve_name('module', 'test_autodoc') == \ @@ -380,6 +388,10 @@ class Class(Base): def undocmeth(self): pass + def skipmeth(self): + """Method that should be skipped.""" + pass + @property def prop(self): """Property.""" |
