DOC, BUILD: fail on doc build warnings #13064
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattip
commented
Mar 1, 2019
| @@ -714,6 +714,7 @@ | |||
|
|
|||
| """)) | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
I am pretty sure the warnings genetated by the Example sections here are bugs. The problem is that the docstring attributes for broadcast.nd, broadcast.ndim, and broadcast.numiter are being inlined rather than linked to, but only for these three attributes.
There was a problem hiding this comment.
Any idea why only those are being inlined?
There was a problem hiding this comment.
No.
It is complicated to find, since the real error is not the warning, but that these attributes are being handled differently by the autsummary mechanism.
eric-wieser
reviewed
Mar 1, 2019
16cdc84 to
6f1a854
Compare
|
Closing in favor of the approach in #13104 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fail documentation builds if there are any warnings.
It turns out my optimism after #13002 was not quite justified. There are a few
warningsnotWARNINGSstill when building documentation, those cause the build to fail when using-WT.@rgommers suggested using
--keep-going. Unfortunately this is a sphinx 1.8+ feature, which we cannot use due to scipy/scipy-sphinx-theme#9, which we really should fix.EDIT: the
scipy-sphinx-themerelated issue was fixed in Sphinx; Sphinx 1.8.3+ is backward compatible.