Create a derivative of the DocstringSignatureMixin which strips

signature strings from attributes. This scenario can occur when using
Cython and turning methods into attributes with an @property
decorator.

1 files changed, 15 insertions, 1 deletions

diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py
index 555a3106..53c7a250 100644
--- a/sphinx/ext/autodoc.py
+++ b/sphinx/ext/autodoc.py
@@ -924,6 +924,20 @@ class DocstringSignatureMixin(object):
                 self.args, self.retann = result
         return Documenter.format_signature(self)
 
+class DocstringStripSignatureMixin(DocstringSignatureMixin):
+    """
+    Mixin for AttributeDocumenter to provide the
+    feature of stripping any function signature from the docstring.
+    """
+    def format_signature(self):
+        if self.args is None and self.env.config.autodoc_docstring_signature:
+            # only act if a signature is not explicitly given already, and if
+            # the feature is enabled
+            result = self._find_signature()
+            if result is not None:
+                self.retann = result[1]
+        return Documenter.format_signature(self)
+    
 
 class FunctionDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter):
     """
@@ -1188,7 +1202,7 @@ class MethodDocumenter(DocstringSignatureMixin, ClassLevelDocumenter):
         pass
 
 
-class AttributeDocumenter(ClassLevelDocumenter):
+class AttributeDocumenter(DocstringStripSignatureMixin,ClassLevelDocumenter):
     """
     Specialized Documenter subclass for attributes.
     """