Skip to content

Sphinx 8.1+: remove redundant --keep-going #1544

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.

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

Merged
merged 1 commit into from
Apr 30, 2025

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Apr 29, 2025

https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going says:

From Sphinx 8.1, --keep-going is always enabled.
...
Changed in version 8.1: sphinx-build no longer exits on the first warning, meaning that in effect --fail-on-warning is always enabled. The option is retained for compatibility, but may be removed at some later date.

We're using Sphinx 8.2:

Sphinx~=8.2.1


📚 Documentation preview 📚: https://cpython-devguide--1544.org.readthedocs.build/

@hugovk
Copy link
Member Author

hugovk commented Apr 29, 2025

meaning that in effect --fail-on-warning is always enabled.

I think this should read --keep-going: sphinx-doc/sphinx#13520

@AA-Turner AA-Turner merged commit 446ccf0 into python:main Apr 30, 2025
5 checks passed
@hugovk hugovk deleted the rm-keep-going branch May 1, 2025 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants