Allows sorting of sections by their title and a custom key function

Author: funkyfuture

autodocsumm/__init__.py

@@ -270,7 +270,12 @@ def get_grouped_documenters(self, all_members=False):
             if not use_sections or section in use_sections:
                 documenters.setdefault(section, []).append(e)
         self.options.update(options_save)
-        return documenters
+
+        if callable(self.env.config.autodocsumm_section_sorter):
+            return {k: documenters[k] for k in sorted(documenters, key=self.env.config.autodocsumm_section_sorter)}
+        else:
+            return documenters
+
 
     def add_autosummary(self, relative_ref_paths=False):
         """Add the autosammary table of this documenter.
@@ -656,6 +661,7 @@ def setup(app):
     app.add_config_value('autodata_content', 'class', True)
     app.add_config_value('document_data', True, True)
     app.add_config_value('not_document_data', [], True)
+    app.add_config_value('autodocsumm_section_sorter', None, True)
     return {'version': sphinx.__display_version__, 'parallel_read_safe': True}
 
 

docs/conf_settings.rst

@@ -135,3 +135,12 @@ Configuration values and events
     To exclude the string representation of specific data objects. You may
     provide a list of fully qualified object names (e.g. in the form of
     ``'zipfile.ZipFile'``) or ``True`` or ``False``
+
+
+.. confval:: autodocsumm_section_sorter
+
+   This can be set with a callable that is passed to :func:`sorted` as key
+   argument to sort the the summary sections by their name. Example usage for
+   an alphanumerical order::
+
+       autodocsumm_section_sorter = lambda s: s

tests/test-root/conf.py

@@ -24,6 +24,8 @@
 
 autodata_content = 'both'
 
+autodocsumm_section_sorter = lambda a: a
+
 
 def member_filter(app, what, name, obj, skip, options):
     import dummy

tests/test_autodocsumm.py

@@ -41,6 +41,10 @@ def get_html(app, fname):
         return f.read()
 
 
+def get_soup(app, fname):
+    return bs4.BeautifulSoup(get_html(app, fname), 'html.parser')
+
+
 def in_autosummary(what, html) -> bool:
     soup = bs4.BeautifulSoup(html, "html.parser")
     autosummaries = soup("table")
@@ -377,6 +381,11 @@ def test_module_submodule(self, app):
         assert re.findall(r'<td>.*href="#dummy_submodule\.submodule2'
                           r'\.SubmoduleClass2\.func2".*</td>', html)
 
+    def test_sorted_sections(self, app):
+        soup = get_soup(app, 'test_autoclasssumm_some_sections.html')
+        sections = soup.select("p strong")
+        assert [s.string[:-1] for s in sections] == ["Attributes", "DummySection"]
+
 
 class TestAutoDocSummDirective:
     """Test case for the :class:`autodocsumm.AutoDocSummDirective`."""