diff options
author | shimizukawa <shimizukawa@gmail.com> | 2016-10-28 00:00:22 +0900 |
---|---|---|
committer | shimizukawa <shimizukawa@gmail.com> | 2016-10-28 00:02:09 +0900 |
commit | a5bdf1fdae99869e3e0e6beab532d62b1df19a3e (patch) | |
tree | 7d3d80fd3f904ba98b63c690b4fa05d99186e7b6 /sphinx/ext/autodoc.py | |
parent | 99147c137293ef569d073d5fa9e01a2fdc136e60 (diff) | |
download | sphinx-git-a5bdf1fdae99869e3e0e6beab532d62b1df19a3e.tar.gz |
Closes #3060: autodoc supports documentation for attributes of Enum class. Now autodoc render just the value of Enum attributes instead of Enum attribute representation.
Diffstat (limited to 'sphinx/ext/autodoc.py')
-rw-r--r-- | sphinx/ext/autodoc.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index 6a1d907fd..890f65646 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -31,7 +31,7 @@ from sphinx.application import ExtensionError from sphinx.util.nodes import nested_parse_with_titles from sphinx.util.compat import Directive from sphinx.util.inspect import getargspec, isdescriptor, safe_getmembers, \ - safe_getattr, object_description, is_builtin_class_method + safe_getattr, object_description, is_builtin_class_method, isenumattribute from sphinx.util.docstrings import prepare_docstring try: @@ -1478,6 +1478,8 @@ class AttributeDocumenter(DocstringStripSignatureMixin, ClassLevelDocumenter): def import_object(self): ret = ClassLevelDocumenter.import_object(self) + if isenumattribute(self.object): + self.object = self.object.value if isdescriptor(self.object) and \ not isinstance(self.object, self.method_types): self._datadescriptor = True |