openstack/openstack-manuals
Code Issues Proposed changes

Merge "Enhance README to explain gating tests"

Browse Source
This commit is contained in:
Jenkins 2014-01-03 00:22:08 +00:00 committed by Gerrit Code Review
commit af9e1b44e4
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
============