Skip to content

Commit 046c0ed

Browse files
authored
Merge pull request #70 from mattsb42-aws/linkcheck
Check links when we build docs!
2 parents c6fbc4a + 5604c33 commit 046c0ed

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

tox.ini

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tox]
22
envlist =
33
py{27,34,35,36}-{local,integ,examples}-fast, nocmk, sourcebuildcheck,
4-
bandit, doc8, readme,
4+
docs, bandit, doc8, readme,
55
flake8, pylint,
66
flake8-tests, pylint-tests,
77
flake8-examples, pylint-examples,
@@ -192,12 +192,23 @@ commands =
192192
pylint --rcfile=examples/src/pylintrc examples/src/
193193
pylint --rcfile=examples/test/pylintrc examples/test/
194194

195+
# Clear out any generated files from doc/
196+
[testenv:resetdocs]
197+
whitelist_externals =
198+
rm
199+
commands =
200+
rm -r doc/lib/generated
201+
195202
[testenv:doc8]
196203
basepython = python3
204+
whitelist_externals = {[testenv:resetdocs]whitelist_externals}
197205
deps =
198206
sphinx
199207
doc8
200-
commands = doc8 doc/index.rst doc/lib/ README.rst CHANGELOG.rst
208+
commands =
209+
{[testenv:resetdocs]commands}
210+
doc8 doc/index.rst doc/lib/ README.rst CHANGELOG.rst
211+
201212

202213
[testenv:readme]
203214
basepython = python3
@@ -244,7 +255,7 @@ commands =
244255
basepython = python3
245256
deps = -rdoc/requirements.txt
246257
commands =
247-
sphinx-build -E -c doc/ -b html doc/ doc/build/html
258+
sphinx-build -E -c doc/ -b html -b linkcheck doc/ doc/build/html
248259

249260
[testenv:serve-docs]
250261
basepython = python3

0 commit comments

Comments
 (0)