From 1e8be6e26fd5928de72ddd63a94dd5062b124dc1 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 2 Jan 2014 17:01:48 +0100 Subject: [PATCH] Enhance README to explain gating tests Add a short section on tox and how its used for gating the tests Change-Id: Id0f2d233aa7446113f93f23db69be0664b160f45 --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index a586e309b8..b7b6123bac 100644 --- a/README.rst +++ b/README.rst @@ -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 ============