Start creating documentation

This commit is contained in:
Ian Cordasco 2016-01-19 07:19:16 -06:00
parent 4e294af81c
commit e66fc2efa8
5 changed files with 340 additions and 0 deletions

22
tox.ini
View file

@ -24,6 +24,28 @@ deps =
commands =
flake8
[testenv:docs]
deps =
sphinx>=1.3.0
commands =
sphinx-build -E -W -c docs/source/ -b html docs/source/ docs/build/html
[testenv:serve-docs]
basepython = python3.4
skipsdist = true
skip_install = true
use_develop = false
changedir = docs/_build/html
deps =
commands =
python -m http.server {posargs}
[testenv:readme]
deps =
readme_renderer
commands =
python setup.py check -r -s
[flake8]
# Ignore some flake8-docstrings errors
ignore = D203