Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sphinx 4.0 regression: warning for autosummary_generate with list type #9188

Closed
StrikerRUS opened this issue May 9, 2021 · 0 comments
Closed

Sphinx 4.0 regression: warning for autosummary_generate with list type #9188

StrikerRUS opened this issue May 9, 2021 · 0 comments
Labels
extensions:autosummary type:bug
Milestone
4.0.1

Comments

@StrikerRUS
Copy link

StrikerRUS commented May 9, 2021 •
edited
Loading 

# conf.py
autosummary_generate = ['Python-API.rst']

Sphinx 4 yields the following warning

Warning, treated as error:
The config value `autosummary_generate' has type `list'; expected `bool'.
make: *** [Makefile:20: html] Error 2

However, official latest docs still say this value can has list type (as it was possible before 4 version).

Can also be a list of documents for which stub pages should be generated.
https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html#confval-autosummary_generate
This was referenced May 9, 2021
Merged
Merged
@tk0miya tk0miya added this to the 4.0.1 milestone May 9, 2021
tk0miya added a commit to tk0miya/sphinx that referenced this issue May 9, 2021
@tk0miya
Fix sphinx-doc#9188: autosummary: warning if list is set to autosumma…
ab6ec71 
…ry_generate
@tk0miya tk0miya mentioned this issue May 9, 2021
Merged
tk0miya added a commit that referenced this issue May 10, 2021
@tk0miya
Merge pull request #9191 from tk0miya/9188_warning_for_autosummary_ge…
5956dc4 
…nerate

Fix #9188: autosummary: warning if list is set to autosummary_generate
@tk0miya tk0miya closed this as completed May 10, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions:autosummary type:bug
Projects
None yet
Milestone
4.0.1
Development

No branches or pull requests
2 participants
@tk0miya @StrikerRUS