#564: Add :confval:`autodoc_docstring_signature` which retrieves the signature from the first line of the docstring, if it is found there.

1 files changed, 16 insertions, 0 deletions

diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py
index d70fa2606..74e69a68c 100644
--- a/tests/test_autodoc.py
+++ b/tests/test_autodoc.py
@@ -492,6 +492,13 @@ def test_generate():
                   ],
                  'class', 'Class', member_order='bysource', all_members=True)
 
+    # 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 ------------
 
@@ -582,3 +589,12 @@ class Outer(object):
 
     # should be documented as an alias
     factory = dict
+
+
+class DocstringSig(object):
+    def meth(self):
+        """
+        meth(FOO, BAR=1) -> BAZ
+
+        rest of docstring
+        """