-
-
Notifications
You must be signed in to change notification settings - Fork 32.3k
Doc: -W flag for sphinx-build can be disabled #10303
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
Conversation
Since 859c068, CI is enforcing -W so we do not need it unconditionally in Doc/Makefile. Making -W optional would help with i18n builds (some versions, like dev, are not actively maintained by translators, and can easily error).
The reason over the change was to catch warnings as errors locally. If it's caught during CI I am okay. It's just that it causes a round trip where make docs passes locally and fails in CI but helps for translated builds. I have added a NEWS entry in my previous PR which can be deleted as part of this PR? https://devguide.python.org/committing/#what-s-new-and-news-entries
Ref : https://github.com/python/cpython/pull/8248/files#diff-07576315d4856b4c89dcc90f4a2704e2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving the changes. News entry can be deleted to avoid confusion. Thanks :)
https://github.com/python/cpython/pull/8248/files#diff-07576315d4856b4c89dcc90f4a2704e2
Implemented nice idea from @matrixise, @tirkarthi what do you think? |
@JulienPalard I am little confused here since my Makefile knowledge is low but isn't it the same as using |
Almost, the precedence in Makefile is "command line beats makefile variables beats environment", so we'll have to pass it as command line, like:
Which is nice as we could also pass:
in the CI to get more than a single error in the report. |
@JulienPalard Thanks for the explanation. LGTM 👍 |
LGTM for me! You can merge it. |
Since 859c068, travis-ci is using -W via SPHINXOPTS so
we do not need it unconditionally in ALLSPHINXOPTS.
So I'm adding -W to Azure CI and droping it from ALLSPHINXOPTS.
Making -W optional would help with i18n builds (some versions, like
dev, are not actively maintained by translators, and can easily error, some countries are also less strict on sphinx errors and yields tons of thems).
cc @matrixise, @tirkarthi