![Tin Lam](/assets/img/avatar_default.png)
This patch set is one of many to add api reference documentation to valet. This specifc patch adds the /v1/groups/ api documentation. User can generate the documentation by ``tox -eapi-ref``. Change-Id: Ic5016abd9f95de98effeaceb4b9f8c1fc7943d6a Signed-off-by: Tin Lam <tin@irrational.io>
64 lines
1.6 KiB
INI
64 lines
1.6 KiB
INI
[tox]
|
|
minversion = 2.3.1
|
|
skipsdist = True
|
|
envlist = docs,py27
|
|
|
|
[testenv]
|
|
usedevelop = True
|
|
install_command = pip install -U {opts} {packages}
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
OS_TEST_PATH=valet/tests/unit
|
|
commands =
|
|
find . -type f -name "*.pyc" -delete
|
|
ostestr --slowest '{posargs}'
|
|
deps = -r{toxinidir}/test-requirements.txt
|
|
whitelist_externals =
|
|
find
|
|
|
|
[testenv:pep8]
|
|
basepython = python2.7
|
|
deps = {[testenv]deps}
|
|
commands = flake8
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:tempest]
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
OS_TEST_PATH=valet/tests/tempest
|
|
commands = python setup.py testr --slowest --testr-args='{posargs}'
|
|
|
|
[testenv:cover]
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
OS_TEST_PATH=valet/tests/unit/
|
|
commands =
|
|
coverage erase
|
|
python setup.py test --slowest --coverage --coverage-package-name 'valet' --testr-args='{posargs}'
|
|
coverage html
|
|
coverage report
|
|
|
|
[testenv:docs]
|
|
basepython = python2.7
|
|
commands =
|
|
python setup.py build_sphinx
|
|
whitelist_externals =
|
|
bash
|
|
|
|
[testenv:api-ref]
|
|
basepython = python2.7
|
|
commands =
|
|
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
|
|
|
|
[flake8]
|
|
filename = *.py
|
|
show-source = true
|
|
# D100: Missing docstring in public module
|
|
# D101: Missing docstring in public class
|
|
# D102: Missing docstring in public method
|
|
# D103: Missing docstring in public function
|
|
# D104: Missing docstring in public package
|
|
# D203: 1 blank line required before class docstring (deprecated in pep257)
|
|
ignore = D100,D101,D102,D103,D104,D203
|
|
builtins = _
|
|
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build
|