DOC, BUILD: fail the devdoc build if there are warnings #13170
Merged
Conversation
This file contains 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 21, 2019
| .. code-block:: C | ||
| :linenos: | ||
| :emphasize-lines: 3, 13, 29, 31 | ||
| template source example:: |
There was a problem hiding this comment.
C formatting does not like the templating syntax so I had to turn it off.
mattip
commented
Mar 21, 2019
| -------------------------------------------------------------------------- | ||
| Previously functions in this module would accept ``float`` values provided they | ||
| were integral (``1.0``, ``2.0``, etc). For consistency with the rest of numpy, | ||
| doing so is now deprecated, and in future will raise a ``TypeError``. |
There was a problem hiding this comment.
Sphinx does not like putting an s right after double-backticks
|
Circle-ci build agrees there are no warnings |
|
Awesome, thanks @mattip |
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.
We can turn on
-WT --keep-goingto fail the documentation build if there are any warnings. This might add to the burden of merging a PR since sometimes new warnings are hard to track down, but it would be better to handle them at the "source".The next step is to turn on
-nwhich currently generates warnings on hundreds of bad references. xref #13114