Run Sphinx in nitpick mode, fix broken cross-references #1575
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
That is, make -Werror apply to broken cross-references too, and disable build caching so we don't hide errors by not building some file.
|
Ping @HypothesisWorks/hypothesis-python-contributors - those not at PyCon UK! - for review? I'd like to get this merged soon, as I've already made another mistake it would have caught and fixing them after the fact is never as satisfying. That was in the release notes for 3.71.6; I've since rebased and fixed this branch so merging will be safe... at least until a similar typo sneaks through! |
Zalathar
approved these changes
Sep 17, 2018
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.
With enough hyperlinks, the structure of our docs matters much less - users can easily jump around until they find what they need, or simply open the reference to something interesting in another tab for later. That requires our cross-references to actually work though, and hence this pull.
With thanks to Trio, where I spotted the
-nflag. The CI trade is bidirectional!