Merge pull request #10 from Chilipp/instance_attr

Resolve bug in autosummary table for instance attributes

Author: Chilipp

autodocsumm/__init__.py

@@ -617,6 +617,8 @@ def get_items_from_documenters(self, documenters):
             documenter.real_modname = documenter.get_real_modname()
             real_name = documenter.fullname
             display_name = documenter.object_name
+            if display_name is None:  # for instance attributes
+                display_name = documenter.objpath[-1]
             if check_module and not documenter.check_module():
                 continue
 

tests/sphinx_supp/dummy.py

@@ -42,6 +42,10 @@ def __call__(self, a, b):
 class TestClass(object):
     """Class test for autosummary"""
 
+    def __init__(self):
+        #: This is an instance attribute
+        self.instance_attribute = 1
+
     def test_method(self):
         """Test if the method is included"""
         pass

tests/test_autodocsumm.py

@@ -79,6 +79,9 @@ def test_module_with_title(self, app, status, warning):
     def test_class(self, app, status, warning):
         app.build()
         html = get_html(app, '/test_class.html')
+
+        self.assertIn('<span class="pre">instance_attribute</span>', html)
+
         self.assertIn('<span class="pre">test_method</span>', html)
         self.assertIn('<span class="pre">test_attr</span>', html)