zaqar/tox.ini
liuyamin 49a397ebfb Use doc8 check
doc8 is a linter for documents and used in openstack-manuals. It is better to
enforce document linters for simple checking.

The current rules are really simple like:
- line length check (80 chars)
- new line at the end of file
- Trailing whitespace

Change-Id: I328e2b2b82739696b95eca4a4130ca347893b0dc
2017-08-10 09:07:41 +08:00

91 lines
2.5 KiB
INI

[tox]
minversion = 1.6
envlist = py35,py27,pypy,pep8
skipsdist = True
[testenv]
usedevelop = True
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
setenv = VIRTUAL_ENV={envdir}
ZAQAR_TESTS_CONFIGS_DIR={toxinidir}/zaqar/tests/etc/
ZAQAR_TEST_MONGODB=1
ZAQAR_TEST_SLOW=1
deps = -r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
commands =
find . -type f -name "*.pyc" -delete
ostestr --concurrency 1 {posargs}
whitelist_externals = find
[testenv:pypy]
setenv = {[testenv]setenv}
JIT_FLAG=--jit off
[testenv:integration]
setenv = {[testenv]setenv}
ZAQAR_TEST_INTEGRATION=1
OS_TEST_PATH=./zaqar/tests/functional
commands = ostestr --concurrency 1 {posargs}
[testenv:pep8]
commands = flake8
[testenv:genconfig]
commands =
oslo-config-generator --config-file etc/oslo-config-generator/zaqar.conf
[testenv:cover]
commands =
python setup.py testr --coverage \
--testr-args='^(?!.*test.*coverage).*$'
coverage report
[testenv:venv]
commands = {posargs}
[testenv:docs]
commands =
doc8 doc/source
python setup.py build_sphinx
sphinx-build -W -b html api-ref/source api-ref/build/html
[testenv:api-ref]
# This environment is called from CI scripts to test and publish
# the API Ref to developer.openstack.org.
#
whitelist_externals = bash
rm
commands =
rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
[testenv:debug]
commands = oslo_debug_helper {posargs}
[testenv:releasenotes]
commands =
doc8 releasenotes/source releasenotes/notes
sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[flake8]
exclude = .venv*,.git,.tox,dist,doc,*lib/python*,*.egg,.update-venv
# NOTE(flaper87): Our currently max-complexity is 15. Not sure what the ideal complexity
# for Zaqar should be but lets keep it to the minimum possible.
max-complexity = 16
# [H904] Delay string interpolations at logging calls.
enable-extensions=H904
[doc8]
# File extensions to check
extensions = .rst, .yaml
# Maximal line length should be 80 but we have some overlong lines.
# Let's not get far more in.
max-line-length = 80
# Disable some doc8 checks:
# D000: Check RST validity
# - cannot handle "none" for code-block directive
ignore = D000
[hacking]
local-check-factory = zaqar.hacking.checks.factory