openstack/openstack-manuals
Code Issues Proposed changes

Enhance README to explain gating tests

Browse Source 
Add a short section on tox and how its used for gating the tests

Change-Id: Id0f2d233aa7446113f93f23db69be0664b160f45
This commit is contained in:
Andreas Jaeger 2014-01-02 17:01:48 +01:00
parent ddc42c85d2
commit 1e8be6e26f
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -57,6 +57,22 @@ The root of the generated HTML documentation is::
openstack-manuals/doc/src/user-guide/target/docbkx/webhelp/user-guide/content/index.html
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.
Contributing
============