Add CI checks for docs building cleanly #294
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
added 3 commits
December 7, 2020 15:43
Since docs are built by CI, people changing the docs don't notice when Sphinx warns about formatting issues. This causes formatting problems to accumulate silently (see #284). This change runs sphinx-build with -W to make all warnings into errors, which causes CI to fail, ensuring warnings are noticed and our docs will always build cleanly.
jli
force-pushed
the
jli-requirecleandocs
branch
from
b4be06c to
c90c959
Compare
muzigao
approved these changes
Dec 8, 2020
muzigao
added a commit
that referenced
this pull request
Nov 12, 2021
Add CI checks for docs building cleanly
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.
Addresses #291