Allows passing True as autodocsumm_section_sorter for simple sorting

Author: funkyfuture

autodocsumm/__init__.py

@@ -271,8 +271,11 @@ def get_grouped_documenters(self, all_members=False):
                 documenters.setdefault(section, []).append(e)
         self.options.update(options_save)
 
-        if callable(self.env.config.autodocsumm_section_sorter):
-            return {k: documenters[k] for k in sorted(documenters, key=self.env.config.autodocsumm_section_sorter)}
+        sort_option = self.env.config.autodocsumm_section_sorter
+        if sort_option is True:
+            return {k: documenters[k] for k in sorted(documenters)}
+        elif callable(sort_option):
+            return {k: documenters[k] for k in sorted(documenters, key=sort_option)}
         else:
             return documenters
 

docs/conf_settings.rst

@@ -139,8 +139,12 @@ Configuration values and events
 
 .. 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
+   When ``True`` the summarizing sections will be sorted alphanumerically by
+   their section title. Alternatively a callable can be set that is passed to
+   :func:`sorted` as key argument to sort the the summary sections by their
+   name.
+   The default value is ``None``.
+   Example usage with a tuple that defines an arbitrary order:
+
+       sections_order = ("Public methods", "Attributes", "Private methods")
+       autodocsumm_section_sorter = lambda title: sections_order.index(title)

tests/test-root/conf.py

@@ -23,7 +23,7 @@
 
 autodata_content = 'both'
 
-autodocsumm_section_sorter = lambda a: a
+autodocsumm_section_sorter = True
 
 
 def member_filter(app, what, name, obj, skip, options):