f18dc29eb0
doc8 is a linter for documents and used in openstack-manuals. It is better to enforce document linters for simple checking. This change is to add doc8 in tox file and fix line too long in some files. The current rules are as bellow: - invalid rst format - D000 - lines should not be longer than 79 characters - D001 - RST exception: line with no whitespace except in the beginning - RST exception: lines with http or https urls - RST exception: literal blocks - RST exception: rst target directives - no trailing whitespace - D002 - no tabulation for indentation - D003 - no carriage returns (use unix newlines) - D004 - no newline at end of file - D005 Change-Id: I5b409fbfd95e05921310c6ecf4afea0220fb0bf0
57 lines
1.3 KiB
INI
57 lines
1.3 KiB
INI
[tox]
|
|
minversion = 1.6
|
|
envlist = py35,py27,pypy,pep8
|
|
skipsdist = True
|
|
|
|
[testenv]
|
|
usedevelop = True
|
|
install_command = pip install -U {opts} {packages}
|
|
setenv =
|
|
VIRTUAL_ENV={envdir}
|
|
deps = -r{toxinidir}/test-requirements.txt
|
|
commands = ostestr {posargs}
|
|
|
|
[testenv:examples]
|
|
setenv = OS_TEST_PATH=./openstack/tests/examples
|
|
passenv = OS_*
|
|
|
|
[functionalbase]
|
|
setenv = OS_TEST_PATH=./openstack/tests/functional
|
|
passenv = OS_*
|
|
|
|
[testenv:functional]
|
|
basepython = python2.7
|
|
setenv = {[functionalbase]setenv}
|
|
passenv = {[functionalbase]passenv}
|
|
|
|
[testenv:functional3]
|
|
basepython = python3.4
|
|
setenv = {[functionalbase]setenv}
|
|
passenv = {[functionalbase]passenv}
|
|
|
|
[testenv:pep8]
|
|
commands = flake8
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
; If this fails for you, you may be running an old version of tox.
|
|
; Run 'pip install tox' to install a newer version of tox.
|
|
[testenv:cover]
|
|
commands = python setup.py test --coverage --coverage-package-name=openstack --testr-args='{posargs}'
|
|
|
|
[testenv:docs]
|
|
commands =
|
|
doc8 doc/source
|
|
python setup.py build_sphinx
|
|
|
|
[flake8]
|
|
ignore=D100,D101,D102,D103,D104,D105,D200,D202,D204,D205,D211,D301,D400,D401
|
|
show-source = True
|
|
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build
|
|
|
|
[doc8]
|
|
extensions = .rst, .yaml
|
|
# Maximal line length should be 80.
|
|
max-line-length = 80
|