352583420d
Baseline changes to comply with OpenStack Documentation Contributor Guide [0] starting with the following sections: - Project guide setup - [1] sphinx-quickstart - [2] doc/source/ layout - Building documentation - [3] tox -e docs - Using documentation tools - [4] openstackdocstheme - Use build-openstack-docs-pti job template for docs - Adding SPDX-License-Identifier: Apache-2.0 [0] https://docs.openstack.org/doc-contrib-guide [1] http://www.sphinx-doc.org/en/master/usage/quickstart.html [2] https://docs.openstack.org/doc-contrib-guide/project-guides.html [3] https://docs.openstack.org/doc-contrib-guide/docs-builds.html [4] https://docs.openstack.org/openstackdocstheme/ Story: 2002708 Task: 26693 Story: 2002813 Task: 26694 Change-Id: I603077bc75bfed4b6032c65dfb308a75cfb0aa76 Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
57 lines
1.7 KiB
INI
57 lines
1.7 KiB
INI
[tox]
|
|
envlist = linters,pep8
|
|
minversion = 2.3
|
|
skipsdist = True
|
|
|
|
[testenv]
|
|
basepython = python3
|
|
install_command = pip install -U {opts} {packages}
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
OS_STDOUT_CAPTURE=1
|
|
OS_STDERR_CAPTURE=1
|
|
OS_TEST_TIMEOUT=60
|
|
deps = -r{toxinidir}/test-requirements.txt
|
|
|
|
[testenv:linters]
|
|
whitelist_externals = bash
|
|
commands =
|
|
bash -c "find {toxinidir} \
|
|
-not \( -type d -name .?\* -prune \) \
|
|
-type f \
|
|
-not -name \*~ \
|
|
-not -name \*.md \
|
|
-name \*.sh \
|
|
-print0 | xargs --no-run-if-empty -0 bashate -v"
|
|
bash -c "find {toxinidir} \
|
|
\( -name middleware/io-monitor/recipes-common/io-monitor/io-monitor/io_monitor/test-tools/yaml/* -prune \) \
|
|
-o \( -name .tox -prune \) \
|
|
-o -type f -name '*.yaml' \
|
|
-print0 | xargs -0 yamllint -d '\{extends: relaxed, rules: \{line-length: \{max: 120\}\}\}'"
|
|
|
|
####
|
|
# Add flake8 as pep8 codestyle check.
|
|
[testenv:pep8]
|
|
description =
|
|
Run style checks.
|
|
commands =
|
|
flake8
|
|
|
|
[flake8]
|
|
# E123, E125 skipped as they are invalid PEP-8.
|
|
# E501 skipped because some of the code files include templates
|
|
# that end up quite wide
|
|
show-source = True
|
|
ignore = E123,E125,E501,H405
|
|
exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,release-tag-*
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:docs]
|
|
basepython = python3
|
|
deps = -r{toxinidir}/doc/requirements.txt
|
|
commands =
|
|
rm -rf doc/build
|
|
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
|
|
whitelist_externals = rm
|