Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Have tests fail on Sphinx documentation errors / warnings #554
Adds a test that fails if Sphinx build has warnings or errors.
(Changelog entry omitted on purpose since it's not a user-visible bugfix/feature)
This is so we can keep documentation at a high quality level, and avoid piling up too many warnings. Especially frustrating is documentation that has been carefully written, but never got published because it wasn't included in a toctree.
The test is a simple bash script that checks the output and return code of
In addition, I fixed all the existing Sphinx warnings.
The build failure is displayed in a way on travis where it should be immediately visible to developers / first time contributors why the build failed.
Example travis build failure: