Skip to content

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

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
Merged
merged 1 commit into from
Apr 30, 2025
Merged

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

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:

cpython/Doc/requirements.txt

Line 10 in 698c6e3

sphinx~=8.2.0

@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 c78216e into python:main Apr 30, 2025
49 checks passed
@miss-islington-app
Copy link

Thanks @hugovk for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 30, 2025
@hugovk @miss-islington
Remove redundant --keep-going when running Sphinx (pythonGH-133156)
e993405 
(cherry picked from commit c78216e)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Apr 30, 2025

GH-133214 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Apr 30, 2025
AA-Turner pushed a commit that referenced this pull request Apr 30, 2025
@miss-islington @hugovk
[3.13] Remove redundant --keep-going when running Sphinx (GH-133156…
110bec8 
…) (#133214)

Remove redundant ``--keep-going`` when running Sphinx (GH-133156)
(cherry picked from commit c78216e)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@hugovk hugovk deleted the 3.14-rm-keep-going branch April 30, 2025 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti ezio-melotti is a code owner

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees
No one assigned
Labels
skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hugovk @AA-Turner