diff options
author | shimizukawa <shimizukawa@gmail.com> | 2016-11-24 23:55:02 +0900 |
---|---|---|
committer | shimizukawa <shimizukawa@gmail.com> | 2016-11-24 23:55:02 +0900 |
commit | 3284e89991a277eaa78e14a7a2adbdfa08a8716e (patch) | |
tree | dd3bf651a47be5f7cc78c2c91031d1c0440fe446 /sphinx/ext/autodoc.py | |
parent | 76f2ed9215ecd8022f8d63ff1c5f455b0bb23354 (diff) | |
parent | def08a206fd885557381309604b7bbd776cdc03c (diff) | |
download | sphinx-git-3284e89991a277eaa78e14a7a2adbdfa08a8716e.tar.gz |
Merge branch 'fix-attr-documenter' into stable
Diffstat (limited to 'sphinx/ext/autodoc.py')
-rw-r--r-- | sphinx/ext/autodoc.py | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index 405d24c88..b9c73f87e 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -42,6 +42,11 @@ try: except ImportError: typing = None +# This type isn't exposed directly in any modules, but can be found +# here in most Python versions +MethodDescriptorType = type(type.__subclasses__) + + #: extended signature RE: with explicit module name separated by :: py_ext_sig_re = re.compile( r'''^ ([\w.]+::)? # explicit module name @@ -1466,10 +1471,13 @@ class AttributeDocumenter(DocstringStripSignatureMixin, ClassLevelDocumenter): @classmethod def can_document_member(cls, member, membername, isattr, parent): + non_attr_types = cls.method_types + (type, MethodDescriptorType) isdatadesc = isdescriptor(member) and not \ - isinstance(member, cls.method_types) and not \ - type(member).__name__ in ("type", "method_descriptor", - "instancemethod") + isinstance(member, non_attr_types) and not \ + type(member).__name__ == "instancemethod" + # That last condition addresses an obscure case of C-defined + # methods using a deprecated type in Python 3, that is not otherwise + # exported anywhere by Python return isdatadesc or (not isinstance(parent, ModuleDocumenter) and not inspect.isroutine(member) and not isinstance(member, class_types)) |