Skip to content

Commit

Permalink
Start running our doc builds in nitpicky mode.
Browse files Browse the repository at this point in the history
This should catch any missing references and other issues.

It's expected to fail currently,
and we should update this branch until things pass properly.
  • Loading branch information
ericholscher committed May 30, 2018
1 parent f083818 commit 8e673f4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ commands =
py.test {posargs}

[testenv:docs]
description = build readthedocs documentation
description = build readthedocs documentation in nitpicky mode -- warn on errors
changedir = {toxinidir}/docs
commands =
sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
sphinx-build -W -n -b html -d {envtmpdir}/doctrees . {envtmpdir}/html

[testenv:docs-lint]
description = run linter (rstcheck) to ensure there aren't errors on our docs
Expand Down

0 comments on commit 8e673f4

Please sign in to comment.