api-site/README
Andreas Jaeger 30f4240e0c Setup for openstack-doc-tools gating
Add files to allow us gating via:
tox -e checkbuild
tox -e checkniceness
etc

Enhance .gitignore to ignore files used by gating and by more
editors.

Change-Id: Id33d04f734d438d01dd5bbd784abaa213de5dbc9
2014-01-02 17:00:03 +01:00

16 lines
584 B
Plaintext

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.