31be1c5ad3
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: I01b11619b42eebf13cb17e1b4a2e8464a8ccc797
68 lines
1.9 KiB
INI
68 lines
1.9 KiB
INI
[tox]
|
|
minversion = 2.0
|
|
skipsdist = True
|
|
envlist = py35,py27,pep8,releasenotes
|
|
|
|
[testenv]
|
|
usedevelop = True
|
|
install_command = {toxinidir}/tools/tox_install.sh {env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
BRANCH_NAME=master
|
|
CLIENT_NAME=keystonemiddleware
|
|
OS_STDOUT_NOCAPTURE=False
|
|
OS_STDERR_NOCAPTURE=False
|
|
TESTS_DIR=./keystonemiddleware/tests/unit/
|
|
|
|
deps = -r{toxinidir}/requirements.txt
|
|
-r{toxinidir}/test-requirements.txt
|
|
.[audit_notifications]
|
|
commands = ostestr {posargs}
|
|
|
|
[testenv:pep8]
|
|
commands =
|
|
flake8
|
|
bandit -r keystonemiddleware -x tests -n5
|
|
|
|
[testenv:bandit]
|
|
# NOTE(browne): This is required for the integration test job of the bandit
|
|
# project. Please do not remove.
|
|
commands = bandit -r keystonemiddleware -x tests -n5
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:cover]
|
|
commands = python setup.py testr --coverage --testr-args='{posargs}'
|
|
|
|
[testenv:debug]
|
|
|
|
commands = oslo_debug_helper -t keystonemiddleware/tests {posargs}
|
|
|
|
[flake8]
|
|
# 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
|
|
show-source = True
|
|
exclude = .venv,.tox,dist,doc,*egg,build
|
|
|
|
[testenv:docs]
|
|
commands=
|
|
doc8 doc/source
|
|
python setup.py build_sphinx
|
|
|
|
[testenv:releasenotes]
|
|
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
|
|
|
[hacking]
|
|
import_exceptions =
|
|
keystonemiddleware.i18n
|
|
|
|
[doc8]
|
|
extensions = .rst, .yaml
|
|
# lines should not be longer than 79 characters.
|
|
max-line-length = 79
|