Fix sphinx-doc#9188: autosummary: warning if list is set to autosumma…

…ry_generate
tk0miya · May 9, 2021 · ab6ec71 · ab6ec71
1 parent f73e061
commit ab6ec71
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CHANGES b/CHANGES
@@ -16,6 +16,9 @@ Features added
 Bugs fixed
 ----------
 
+* #9188: autosummary: warning is emitted if list value is set to
+  autosummary_generate
+
 Testing
 --------
 

diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py
@@ -773,7 +773,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     app.connect('builder-inited', process_generate_options)
     app.add_config_value('autosummary_context', {}, True)
     app.add_config_value('autosummary_filename_map', {}, 'html')
-    app.add_config_value('autosummary_generate', True, True, [bool])
+    app.add_config_value('autosummary_generate', True, True, [bool, list])
     app.add_config_value('autosummary_generate_overwrite', True, False)
     app.add_config_value('autosummary_mock_imports',
                          lambda config: config.autodoc_mock_imports, 'env')
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,9 @@ Features added @@
     Bugs fixed
     ----------
+    * #9188: autosummary: warning is emitted if list value is set to
+      autosummary_generate
     Testing
     --------
@@ Expand Down @@