Make the CI fail when the docs syntax is invalid #287
Merged
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.
Changes
Adds a step to build the docs in the CI, failing if something if the syntax is wrong. This will help enforce good docs, now that we publish them to Readthedocs.
References
List of options: https://www.sphinx-doc.org/en/master/man/sphinx-build.html
-W
converts warnings to errors--keep-going
will not stop in the first error, useful to get the complete list of errors.-n
will verify broken links and references-a
runs the docs generation task even when the source code hasn't changedTesting
Checklist