Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 721 Bytes

tox.rst

File metadata and controls

30 lines (23 loc) · 721 Bytes
Raw

Testing your Documentation

If you want to confirm that your docs build successfully, you add this to your tox.ini file:

[tox]
envlist = sphinx, readme

[testenv:sphinx]
deps =
    Sphinx
commands =
    make --directory=docs clean html
whitelist_externals =
    make

[testenv:readme]
deps =
    docutils
    pygments
commands =
    rst2html.py --exit-status=2 README.rst /tmp/README.html
    rst2html.py --exit-status=2 CONTRIBUTING.rst /tmp/CONTRIBUTING.html

TODO: Explain in depth what this actually does.

TODO: Explain what tox is.