diff options
author | Georg Brandl <georg@python.org> | 2011-01-06 13:07:07 +0100 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2011-01-06 13:07:07 +0100 |
commit | 556925036c9f287a871ed972fcc0630523df8539 (patch) | |
tree | 5b6a4fbb10eb689c11914ffb03dd41dd7b5c63e3 /tests/test_autodoc.py | |
parent | a53ec83ec754525cd0d3d8015a0290c12b44bf9c (diff) | |
parent | cd153a36e9edd5854fe9c6ff4499d710278b9bfa (diff) | |
download | sphinx-556925036c9f287a871ed972fcc0630523df8539.tar.gz |
merge with 1.0
Diffstat (limited to 'tests/test_autodoc.py')
-rw-r--r-- | tests/test_autodoc.py | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index a367fb93..8f9025e6 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -31,6 +31,8 @@ def setup_module(): options = Struct( inherited_members = False, undoc_members = False, + private_members = False, + special_members = False, show_inheritance = False, noindex = False, synopsis = '', @@ -500,6 +502,13 @@ def test_generate(): 'attribute', 'mdocattr') del directive.env.temp_data['autodoc:class'] + # test autodoc_docstring_signature + assert_result_contains( + '.. py:method:: DocstringSig.meth(FOO, BAR=1) -> BAZ', 'method', + 'test_autodoc.DocstringSig.meth') + assert_result_contains( + ' rest of docstring', 'method', 'test_autodoc.DocstringSig.meth') + # --- generate fodder ------------ @@ -594,3 +603,12 @@ class Outer(object): # should be documented as an alias factory = dict + + +class DocstringSig(object): + def meth(self): + """meth(FOO, BAR=1) -> BAZ +First line of docstring + + rest of docstring + """ |