a8ec3317be
Make use of doc8 to verify all rst files which are not autogenerated for errors and fail if there are any issues found. The doc8 checks are now part of the tox 'docs' environment and ran automatically. Checks can also be called direcly via 'tox -e docs'. Fix all issues found by doc8. Closes-Bug: #1664841 Change-Id: I9215524d35646de7485504e4c5ff86fd91a1d09f Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
110 lines
3.1 KiB
INI
110 lines
3.1 KiB
INI
[tox]
|
|
minversion = 2.0
|
|
skipsdist = True
|
|
envlist = py35,py27,pep8
|
|
|
|
[testenv]
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
usedevelop = True
|
|
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
|
|
whitelist_externals = find
|
|
deps = -r{toxinidir}/requirements.txt
|
|
-r{toxinidir}/test-requirements.txt
|
|
commands =
|
|
find . -type f -name "*.py[c|o]" -delete
|
|
ostestr {posargs}
|
|
|
|
[testenv:releasenotes]
|
|
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees \
|
|
-b html releasenotes/source releasenotes/build/html
|
|
|
|
[testenv:install-guide]
|
|
# builds to install-guide/build/html
|
|
commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html
|
|
|
|
[testenv:debug]
|
|
commands = oslo_debug_helper {posargs}
|
|
|
|
[testenv:debug-py27]
|
|
basepython = python2.7
|
|
commands = oslo_debug_helper {posargs}
|
|
|
|
[testenv:debug-py35]
|
|
basepython = python3.5
|
|
commands = oslo_debug_helper {posargs}
|
|
|
|
[testenv:pep8]
|
|
commands =
|
|
flake8 {posargs}
|
|
# Run bashate during pep8 runs to ensure violations are caught by
|
|
# the check and gate queues.
|
|
bashate -i E006,E042,E043 \
|
|
tools/enable-pre-commit-hook.sh \
|
|
contrib/ci/pre_test_hook.sh \
|
|
contrib/ci/post_test_hook.sh \
|
|
devstack/plugin.sh \
|
|
devstack/upgrade/from-mitaka/upgrade-manila \
|
|
devstack/upgrade/resources.sh \
|
|
devstack/upgrade/shutdown.sh \
|
|
devstack/upgrade/upgrade.sh \
|
|
tools/cover.sh \
|
|
tools/check_logging.sh \
|
|
run_tests.sh
|
|
{toxinidir}/tools/check_exec.py {toxinidir}/manila
|
|
{toxinidir}/tools/check_exec.py {toxinidir}/manila_tempest_tests
|
|
{toxinidir}/tools/check_logging.sh {toxinidir}/manila
|
|
|
|
[testenv:genconfig]
|
|
whitelist_externals = bash
|
|
commands =
|
|
oslo-config-generator --config-file etc/oslo-config-generator/manila.conf
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:docs]
|
|
commands =
|
|
python setup.py build_sphinx
|
|
doc8 --ignore D001 --ignore-path .tox --ignore-path doc/build --ignore-path manila.egg-info -e txt -e rst
|
|
|
|
[testenv:cover]
|
|
commands = {toxinidir}/tools/cover.sh {posargs}
|
|
|
|
[testenv:fast8]
|
|
commands =
|
|
{toxinidir}/tools/fast8.sh
|
|
|
|
[testenv:pylint]
|
|
deps = -r{toxinidir}/requirements.txt
|
|
pylint==0.26.0
|
|
whitelist_externals = bash
|
|
commands = bash tools/lintstack.sh
|
|
|
|
[testenv:lint]
|
|
deps = -r{toxinidir}/requirements.txt
|
|
pylint==0.26.0
|
|
commands = python tools/lintstack.py check
|
|
|
|
[testenv:api-ref]
|
|
# This environment is called from CI scripts to test and publish
|
|
# the API Ref to developer.openstack.org.
|
|
whitelist_externals = 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:dbrevision]
|
|
deps = -r{toxinidir}/requirements.txt
|
|
commands = alembic -c manila/db/migrations/alembic.ini revision -m ""{posargs}
|
|
|
|
[flake8]
|
|
# Following checks are ignored on purpose:
|
|
ignore =
|
|
builtins = _
|
|
exclude = .git,.tox,.testrepository,.venv,build,cover,dist,doc,*egg,api-ref/build,*/source/conf.py
|
|
|
|
[hacking]
|
|
import_exceptions =
|
|
manila.i18n
|
|
local-check-factory = manila.hacking.checks.factory
|