6019a07f29
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 [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: 26510 Story: 2002813 Task: 26509 Change-Id: I30a92b228540eebd0f991e0c90675bc12d925894 Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
57 lines
1.5 KiB
INI
57 lines
1.5 KiB
INI
[tox]
|
|
envlist = linters
|
|
minversion = 2.3
|
|
skipsdist = True
|
|
|
|
[testenv]
|
|
basepython = python3
|
|
install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/pike} {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 -0 bashate -v -e E* \
|
|
-i E006,E010"
|
|
|
|
bash -c "find {toxinidir} \
|
|
\( -name .tox -prune \) \
|
|
-o -type f -name '*.yaml' \
|
|
-print0 | xargs -0 yamllint -f parsable \
|
|
-c {toxinidir}/.yamllint"
|
|
|
|
[testenv:pep8]
|
|
usedevelop = False
|
|
skip_install = True
|
|
deps =
|
|
pep8
|
|
commands =
|
|
pep8
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:flake8]
|
|
description = Dummy environment to allow flake8 to be run in subdir tox
|
|
|
|
[testenv:pylint]
|
|
description = Dummy environment to allow pylint to be run in subdir tox
|
|
|
|
[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
|