Merge pull request #38 from Chilipp/class_order

allow specifying the member-order

Author: Chilipp

autodocsumm/__init__.py

@@ -199,6 +199,17 @@ def get_grouped_documenters(self, all_members=False):
             documenter = classes[-1](self.directive, full_mname, self.indent)
             memberdocumenters.append((documenter,
                                       members_check_module and not isattr))
+
+        member_order = (
+            self.options.member_order or self.env.config.autodoc_member_order
+        )
+        try:
+            memberdocumenters = self.sort_members(
+                memberdocumenters, member_order
+            )
+        except AttributeError:  # sphinx<3.0
+            pass
+
         documenters = OrderedDict()
         for e in memberdocumenters:
             section = self.member_sections.get(

tests/sphinx_supp/index.rst

@@ -6,6 +6,7 @@ Example documentation
     test_module
     test_module_summary_only
     test_class
+    test_class_order
     test_class_summary_only
     test_inherited
     test_module_title

tests/sphinx_supp/test_class_order.rst

@@ -0,0 +1,5 @@
+Dummy Class Doc
+===============
+
+.. autoclass:: dummy.TestClass
+    :member-order: bysource

tests/test_autodocsumm.py

@@ -160,6 +160,30 @@ def test_class(self, app, status, warning):
             html, '<span class="pre">InnerClass</span>', 'Classes',
             'DummySection'))
 
+    @with_app(buildername='html', srcdir=sphinx_supp,
+              copy_srcdir_to_tmpdir=True)
+    @unittest.skipIf(
+        sphinx_version[:2] < [3, 1], "Only available for sphinx>=3"
+    )
+    def test_class_order(self, app, status, warning):
+        app.build()
+        html = get_html(app, '/test_class_order.html')
+
+        if sphinx_version[:2] > [3, 1]:
+            self.assertIn(
+                '<span class="pre">instance_attribute</span>',
+                html)
+        elif sphinx_version[:2] < [3, 1]:
+            self.assertIn(
+                '<span class="pre">dummy.TestClass.instance_attribute</span>',
+                html)
+
+        self.assertIn('<span class="pre">test_attr</span>', html)
+        self.assertIn('<span class="pre">large_data</span>', html)
+
+        self.assertLess(html.index('<span class="pre">test_attr</span>'),
+                        html.index('<span class="pre">large_data</span>'))
+
     @with_app(buildername='html', srcdir=sphinx_supp,
               copy_srcdir_to_tmpdir=True)
     def test_class_summary_only(self, app, status, warning):