Merge pull request #9191 from tk0miya/9188_warning_for_autosummary_ge…

…nerate Fix #9188: autosummary: warning if list is set to autosummary_generate
sphinx-doc · May 10, 2021 · 5956dc4 · 5956dc4
2 parents 7c16981 + 88ef2b3
commit 5956dc4
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/CHANGES b/CHANGES
@@ -18,6 +18,8 @@ Bugs fixed
 
 * #9189: autodoc: crashed when ValueError is raised on generating signature
   from a property of the class
+* #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')