summaryrefslogtreecommitdiff
path: root/tests/test_autodoc.py
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2011-01-07 19:04:53 +0100
committerGeorg Brandl <georg@python.org>2011-01-07 19:04:53 +0100
commit272025df2e6e392dba2f535127ae41bf3ead6562 (patch)
tree64ab96a609f758025efa124c99ec4b63366676d0 /tests/test_autodoc.py
parent75ae889c2da945ae3478c003ba7b58526150013d (diff)
parent554c7dd64f6aca38be6e1d26bb2cf4388f46083d (diff)
downloadsphinx-272025df2e6e392dba2f535127ae41bf3ead6562.tar.gz
merge with 1.0
Diffstat (limited to 'tests/test_autodoc.py')
-rw-r--r--tests/test_autodoc.py18
1 files changed, 18 insertions, 0 deletions
diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py
index e8a7d29f..3e9b4f25 100644
--- a/tests/test_autodoc.py
+++ b/tests/test_autodoc.py
@@ -32,6 +32,8 @@ def setup_module():
options = Struct(
inherited_members = False,
undoc_members = False,
+ private_members = False,
+ special_members = False,
show_inheritance = False,
noindex = False,
synopsis = '',
@@ -501,6 +503,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 ------------
@@ -595,3 +604,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
+ """