-
Notifications
You must be signed in to change notification settings - Fork 441
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
Switch to using sphinx keep-going flag #2719
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2719 +/- ##
=======================================
Coverage 93.81% 93.81%
=======================================
Files 76 76
Lines 16195 16195
=======================================
Hits 15194 15194
Misses 1001 1001 |
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.
Good catch. LGTM.
Reference: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going
Recommending merge on 1 June 2022 unless further comments are given or issues are raised. |
Turns out we're already not capturing these warnings. |
Main issue here is somehow the Since the underlying issue will be fixed anyway in #2695, I think this is sufficient for now to clean up these errors. |
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 after checking the CI pass.
Suggest merging on June 5th. |
This PR changes our documentation build to use
--keep-going
rather than our custom error catching script. See sphinx-build options.Within the PyAnsys project, we've discovered that it's a brittle script and it's better to use a tried and true method rather than potentially letting warnings slip by. Plus, it's one less script to maintain.