New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Have tests fail on Sphinx documentation errors / warnings #554

Merged
merged 5 commits into from Jun 24, 2018

Conversation

Projects
None yet
4 participants
@lukasgraf
Member

lukasgraf commented Jun 23, 2018

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 bin/sphinxbuild and errors out to fail the build if either

  • bin/sphinxbuild exited with return code 1 (hard errors)
  • the output contains WARNINGs

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:

sphinx_warnings

lukasgraf added some commits Mar 20, 2017

Add test that fails if Sphinx build has warnings or errors:
This is a simple bash script that checks the output and return code
of bin/sphinxbuild and errors out to fail the build if either
- bin/sphinxbuild exited with return code 1 (hard errors)
- the output contains WARNINGs
@davisagli

This comment has been minimized.

Member

davisagli commented Jun 23, 2018

Nice!

@coveralls

This comment has been minimized.

coveralls commented Jun 23, 2018

Coverage Status

Coverage increased (+0.5%) to 96.182% when pulling 5905ece on test-for-sphinx-warnings into 88a7f61 on master.

@tisto tisto merged commit 30edcd5 into master Jun 24, 2018

3 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
coverage/coveralls Coverage increased (+0.5%) to 96.182%
Details

@tisto tisto deleted the test-for-sphinx-warnings branch Jun 24, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment