sphinx-build: fail on warning #7093
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
|
Thanks @donsizemore. This'll force us to write proper docs! :) |
pdurbin
approved these changes
Jul 17, 2020
There was a problem hiding this comment.
I tried the -W flag locally and I'm already glad we're doing this. It found a real bug (#7099), which I just fixed in a separate pull request.
We could write a little more about this at http://guides.dataverse.org/en/4.20/developers/documentation.html#using-sphinx but I think it's ok to live with it for a few months first.
This was referenced Aug 25, 2020
Closed
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.
What this PR does / why we need it: a growing number of warnings during sphinx-build of guides
Which issue(s) this PR closes:
Closes #7092
Special notes for your reviewer: change made per https://documentation.help/Sphinx/invocation.html
Suggestions on how to test this: insert garbage into one of the guide files, expect sphinx-build to fail:
Warning, treated as error: /home/worker/workspace/OdumInstitute-Guides-PR_PR-37/doc/sphinx-guides/source/admin/index.rst:document isn't included in any toctreeDoes this PR introduce a user interface change? If mockups are available, please link/include them here: no
Is there a release notes update needed for this change?: no(?)
Additional documentation: none