IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9191 from tk0miya/9188_warning_for_autosummary_generate

Browse Source 
Fix #9188: autosummary: warning if list is set to autosummary_generate
This commit is contained in:
Takeshi KOMIYA 2021-05-11 00:06:21 +09:00 committed by GitHub
commit 5956dc4a65
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -18,6 +18,8 @@ Bugs fixed
* #9189: autodoc: crashed when ValueError is raised on generating signature * #9189: autodoc: crashed when ValueError is raised on generating signature
from a property of the class from a property of the class
* #9188: autosummary: warning is emitted if list value is set to
autosummary_generate
Testing Testing
-------- --------

2
sphinx/ext/autosummary/__init__.py
View File

@ -773,7 +773,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
app.connect('builder-inited', process_generate_options) app.connect('builder-inited', process_generate_options)
app.add_config_value('autosummary_context', {}, True) app.add_config_value('autosummary_context', {}, True)
app.add_config_value('autosummary_filename_map', {}, 'html') 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_generate_overwrite', True, False)
app.add_config_value('autosummary_mock_imports', app.add_config_value('autosummary_mock_imports',
lambda config: config.autodoc_mock_imports, 'env') lambda config: config.autodoc_mock_imports, 'env')