openstack/governance
Code Issues Proposed changes
28f210dc43
governance/tox.ini

28 lines
660 B
INI
Raw Normal View History

provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
[tox]
Create a generic linters tox environment Move yamllimt and check_projects_yaml_alphabetized into a generic linters environment which can then be called from in the gate to keep yaml data clean. This can be extended later to include pep8 and other tools if desired Needed-By: I92b38a8363d716fd2b844ff9c6db7dc74f4b4bfc Change-Id: I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db
2016-10-04 15:52:15 +11:00
envlist = docs,linters
provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
minversion = 1.6
skipsdist = True
[testenv]
begin conversion to rst This converts 2 of the reference documents to rst, and fixes the tox.ini so that tox -e docs creates a pretty html version of these documents. While the publish target location has still not been sorted this moves the ball forward in generating nicer output for the documents. The incubation-integration-requirements document was intentionally left out, because it's much more active, and we should decide this is the right approach before we impose the merge conflicts on everyone in flight. Change-Id: I2fefdb5efe196cdbda4555141b09e7e771e20bdd
2014-04-15 08:24:17 -04:00
usedevelop = True
provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
install_command = pip install -U {opts} {packages}
setenv = VIRTUAL_ENV={envdir}
begin conversion to rst This converts 2 of the reference documents to rst, and fixes the tox.ini so that tox -e docs creates a pretty html version of these documents. While the publish target location has still not been sorted this moves the ball forward in generating nicer output for the documents. The incubation-integration-requirements document was intentionally left out, because it's much more active, and we should decide this is the right approach before we impose the merge conflicts on everyone in flight. Change-Id: I2fefdb5efe196cdbda4555141b09e7e771e20bdd
2014-04-15 08:24:17 -04:00
deps = -r{toxinidir}/test-requirements.txt
provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
Create a generic linters tox environment Move yamllimt and check_projects_yaml_alphabetized into a generic linters environment which can then be called from in the gate to keep yaml data clean. This can be extended later to include pep8 and other tools if desired Needed-By: I92b38a8363d716fd2b844ff9c6db7dc74f4b4bfc Change-Id: I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db
2016-10-04 15:52:15 +11:00
[testenv:linters]
Reduce the scope of yamllints coverage Since I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db the non-voting linters target has been failign as it was also checking yaml files in the virtualenvs created by tox [1]. This change modifies the way we invoke yamllint so that only files we actually care about are linted. We also configure yamllint to have a slight more generous line-length limit and to disable the 'truthy'[2] rule. [1] http://logs.openstack.org/10/382110/2/check/gate-governance-linters-ubuntu-xenial/6c8ae21/console.html#_2016-10-11_15_39_52_575891 [2] https://yamllint.readthedocs.io/en/latest/rules.html#module-yamllint.rules.truthy Change-Id: Ia0337aa49efb9ec832356eed374cc56bac1e75bc
2016-10-18 14:09:41 +11:00
whitelist_externals = bash
commands = bash -c "find {toxinidir} \
\( -name .tox -prune \) \
-o -type f -name '*.yaml' \
-print0 | xargs -0 yamllint"
Create a generic linters tox environment Move yamllimt and check_projects_yaml_alphabetized into a generic linters environment which can then be called from in the gate to keep yaml data clean. This can be extended later to include pep8 and other tools if desired Needed-By: I92b38a8363d716fd2b844ff9c6db7dc74f4b4bfc Change-Id: I76bc62ef22d09e1b6c19ebcd9b12f6381e1fd2db
2016-10-04 15:52:15 +11:00
{toxinidir}/tools/check_projects_yaml_alphabetized.sh
provide infrastructure for publishing docs to html this brings over the pbr infrastructure for publishing rst files to html with the oslo.sphix style. We'll need to move around and reformat some of the documents for them to fully take effect but this would be the first step in getting there. Updated with our latest knowledge on how to do the right tox.ini changes to handle sphinx issues. This will then get used by another publish job to go to some online repository. Change-Id: I0dd3ecf0a9b3e356a4a2980a305b421b7d7b8602
2013-12-11 06:18:49 -05:00
[testenv:venv]
commands = {posargs}
begin conversion to rst This converts 2 of the reference documents to rst, and fixes the tox.ini so that tox -e docs creates a pretty html version of these documents. While the publish target location has still not been sorted this moves the ball forward in generating nicer output for the documents. The incubation-integration-requirements document was intentionally left out, because it's much more active, and we should decide this is the right approach before we impose the merge conflicts on everyone in flight. Change-Id: I2fefdb5efe196cdbda4555141b09e7e771e20bdd
2014-04-15 08:24:17 -04:00
[testenv:docs]
commands = python setup.py build_sphinx
Add tox env for validate_tags script This way the script can be run as: $tox -e validate Change-Id: Ia90bd02ab2e20dd99d613f91c9cd6b92eb9d94d8
2015-12-20 15:16:49 -05:00
[testenv:validate]
commands = python tools/validate_tags.py
Copy Permalink