[docs/ci] cleanup docs and add ci to check it #485
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
zhemao
reviewed
Mar 17, 2020
| - run: | ||
| name: Check that documentation builds with no warnings/errors | ||
| command: | | ||
| make -C docs html |
There was a problem hiding this comment.
Are you sure this actually gives a failing error code if there are only warnings?
There was a problem hiding this comment.
Yes because that's how I fixed the other documentation errors (missing references to labels).
abejgonzalez
commented
Mar 17, 2020
| @@ -2,8 +2,8 @@ | |||
| # | |||
|
|
|||
| # You can set these variables from the command line. | |||
| SPHINXOPTS = -w warnings.txt | |||
| SPHINXBUILD = python -msphinx | |||
| SPHINXOPTS = -w warnings.txt -n -W | |||
Merged
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.
Related issue: Fixes #483
Type of change: other enhancement
Impact: other
Release Notes
This runs CI on the documentation to make sure that documentation changes still build properly (very strict checking and errors as soon as possible).