several compatibility fixes for sphinx 3.5

Author: Chilipp

autodocsumm/__init__.py

@@ -20,7 +20,7 @@
 
 from sphinx.ext.autodoc import (
     ClassDocumenter, ModuleDocumenter, ALL, PycodeError,
-    ModuleAnalyzer, bool_option, AttributeDocumenter, DataDocumenter, Options,
+    ModuleAnalyzer, AttributeDocumenter, DataDocumenter, Options,
     prepare_docstring)
 import sphinx.ext.autodoc as ad
 
@@ -85,6 +85,10 @@ def list_option(option):
     return [s.strip() for s in option.split(";;")]
 
 
+def bool_option(*args):
+    return "True"
+
+
 class AutosummaryDocumenter(object):
     """Abstract class for for extending Documenter methods
 
@@ -230,7 +234,10 @@ def get_grouped_documenters(self, all_members=False):
 
     def add_autosummary(self):
         """Add the autosammary table of this documenter."""
-        if self.options.autosummary:
+        if (
+            self.options.get("autosummary")
+            and not self.options.get("no-autosummary")
+        ):
 
             grouped_documenters = self.get_grouped_documenters()
 
@@ -297,7 +304,7 @@ def add_content(self, *args, **kwargs):
         self.add_autosummary()
 
         if self.options.autosummary_no_nesting:
-            self.options.autosummary = False
+            self.options["no-autosummary"] = "True"
 
 
 class AutoSummClassDocumenter(ClassDocumenter, AutosummaryDocumenter):
@@ -524,10 +531,10 @@ def run(self):
         objtype = self.name[4:-4]  # strip prefix (auto-) and suffix (-summ).
         doccls = self.env.app.registry.documenters[objtype]
 
-        self.options['autosummary-force-inline'] = True
-        self.options['autosummary'] = True
+        self.options['autosummary-force-inline'] = "True"
+        self.options['autosummary'] = "True"
         if 'no-members' not in self.options:
-            self.options['members'] = True
+            self.options['members'] = ""
 
         # process the options with the selected documenter's option_spec
         try:

tests/sphinx_supp/conf.py

@@ -20,6 +20,8 @@
     'dummy.large_data', 'dummy.TestClass.small_data',
     'dummy_title.large_data', 'dummy_title.TestClass.small_data']
 
+autodoc_typehints = "description"
+
 autodata_content = 'both'
 
 

tests/test_autodocsumm.py

@@ -50,10 +50,27 @@ def test_module(self, app, status, warning):
         self.assertIn('<span class="pre">small_data</span>', html)
 
         self.assertNotIn('Should be skipped', html)
-        self.assertIn('Should be included', html)
+        try:
+            self.assertIn('Should be included', html)
+        except AssertionError: # sphinx>=3.5
+            self.assertIn(
+                '<span class="pre">\'Should</span> '
+                '<span class="pre">be</span> '
+                '<span class="pre">included\'</span>',
+                html
+            )
 
         self.assertNotIn('Should also be skipped', html)
-        self.assertIn('Should also be included', html)
+        try:
+            self.assertIn('Should also be included', html)
+        except AssertionError: # sphinx>=3.5
+            self.assertIn(
+                '<span class="pre">\'Should</span> '
+                '<span class="pre">also</span> '
+                '<span class="pre">be</span> '
+                '<span class="pre">included\'</span>',
+                html
+            )
 
     @with_app(buildername='html', srcdir=sphinx_supp,
               copy_srcdir_to_tmpdir=True)
@@ -146,7 +163,15 @@ def test_class(self, app, status, warning):
         self.assertIn('<span class="pre">small_data</span>', html)
 
         self.assertNotIn('Should be skipped', html)
-        self.assertIn('Should be included', html)
+        try:
+            self.assertIn('Should be included', html)
+        except AssertionError: # sphinx>=3.5
+            self.assertIn(
+                '<span class="pre">\'Should</span> '
+                '<span class="pre">be</span> '
+                '<span class="pre">included\'</span>',
+                html
+            )
 
         self.assertIn('DummySection', html)
         self.assertTrue(in_between(