Rahman Syed d4a5555e52 Improve python-designateclient docs
* Improve index page to explain the difference between v1 and v2
  CLI support.
* Add a v2 examples page
* Add all supported commands to v2 shell page
* Add a tox task to build the docs
* Fix a bug building the docs with an invalid html_static_path
  config

Change-Id: Ie1e65c2d0cc8ad1b8b258e03114e19a943d1d19c
Closes-Bug: 1572217
2016-04-20 11:57:57 -05:00

65 lines
1.6 KiB
INI

[tox]
envlist = py34,py27,flake8
minversion = 1.6
skipsdist = True
[testenv]
usedevelop = True
install_command = pip install {opts} {packages}
setenv = VIRTUAL_ENV={envdir}
LANG=en_US.UTF-8
LANGUAGE=en_US:en
LC_ALL=C
deps = -r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
whitelist_externals = find
sh
commands =
find . -type f -name "*.pyc" -delete
sh tools/pretty_tox.sh '{posargs}'
passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
[testenv:docs]
commands = rm -rf doc/build
sphinx-build -E -W -b html doc/source doc/build/html
[testenv:flake8]
commands = flake8
[testenv:pep8]
commands = flake8
[testenv:pyflakes]
commands = flake8
[testenv:cover]
commands = python setup.py testr --coverage --testr-args='{posargs}'
[testenv:venv]
commands = {posargs}
[testenv:functional]
usedevelop = False
setenv = VIRTUAL_ENV={envdir}
OS_TEST_PATH=designateclient/functionaltests/
passenv = OS_STDOUT_CAPTURE
OS_STDERR_CAPTURE
OS_LOG_CAPTURE
OS_DEBUG
TEMPEST_CONFIG
[flake8]
# ignored flake8 codes:
# H302 import only modules
# H402 one line docstring needs punctuation
# H404 multi line docstring should start with a summary
# H405 multi line docstring summary not separated with an empty line
# H904 Wrap long lines in parentheses instead of a backslash
# See designate for other ignored codes that may apply here
ignore = H302,H402,H404,H405,H904
builtins = _
exclude = .venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build,tools