Enable for gating with openstack-doc-tools

Add files to allow us gating via:
tox -e checkbuild
tox -e checkniceness
etc

Change-Id: I7b1754c94ebecf41683576a41b643bbe124b3b3e
This commit is contained in:
Andreas Jaeger 2013-12-31 17:22:04 +01:00
parent 8ea3ddeb4a
commit c3a4fd596d
3 changed files with 44 additions and 0 deletions

16
README
View File

@ -35,6 +35,22 @@ or at a meetup and offer contributions through our processes, the `OpenStack
wiki <http://wiki.openstack.org>`_, blogs, or on IRC at ``#openstack``
on ``irc.freenode.net``.
Testing of changes and building of the manual
=============================================
Install the python tox package and run "tox" from the top-level
directory to use the same tests that are done as part of our Jenkins
gating jobs.
If you like to run individual tests, run:
* "tox -e checkniceness" - to run the niceness tests
* "tox -e checksyntax" - to run syntax checks
* "tox -e checkdeletions" - to check that no deleted files are referenced
* "tox -e checkbuild" - to actually build the manual
tox will use the openstack-doc-tools package for execution of these
tests.
Installing OpenStack
====================
Refer to http://docs.openstack.org to see where these documents are published

1
test-requirements.txt Normal file
View File

@ -0,0 +1 @@
openstack-doc-tools

27
tox.ini Normal file
View File

@ -0,0 +1,27 @@
[tox]
minversion = 1.6
envlist = checkbuild,checkdeletions,checkniceness,checksyntax
skipsdist=True
[testenv]
setenv =
VIRTUAL_ENV={envdir}
LANG=en_US.UTF-8
LANGUAGE=en_US:en
LC_ALL=C
deps = -r{toxinidir}/test-requirements.txt
[testenv:venv]
commands = {posargs}
[testenv:checkniceness]
commands = openstack-doc-test --check-niceness
[testenv:checksyntax]
commands = openstack-doc-test --check-syntax
[testenv:checkdeletions]
commands = openstack-doc-test --check-deletions
[testenv:checkbuild]
commands = openstack-doc-test --check-build