Skip to content

Commit

Permalink
add 'tox -e docs', to check+render .rst files
Browse files Browse the repository at this point in the history
  • Loading branch information
warner committed Mar 31, 2016
1 parent 2b5633e commit dfc0974
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,18 @@ commands =
python src/allmydata/test/check_memory.py download-GET
python src/allmydata/test/check_memory.py download-GET-slow
python src/allmydata/test/check_memory.py receive

# Use 'tox -e docs' to check formatting and cross-references in docs .rst
# files. The published docs are built by code run over at readthedocs.org,
# which does not use this target (but does something similar).
#
# If you have "sphinx" installed in your virtualenv, you can just do "make -C
# docs html", or "cd docs; make html".
#
# You can also open docs/_build/html/index.html to see the rendered docs in
# your web browser.

[testenv:docs]
deps = sphinx
commands =
sphinx-build -b html -d {toxinidir}/docs/_build/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html

0 comments on commit dfc0974

Please sign in to comment.