openstack
/
api-site
Code Issues Proposed changes
OpenStack API site
773 Commits 1 Branch 0 Tags 45 MiB
CSS 74.6%
JavaScript 15.7%
HTML 6.6%
Python 2.6%
Shell 0.5%
Go to file
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
api-quick-start Fix whitespace problems in api-quick-start and api-ref 2013-12-23 21:39:52 +01:00
api-ref Merge "Fix validation errors discovered by new gate: https://review.openstack.org/#/c/63831/" 2013-12-31 14:51:44 +00:00
www Remove extra www/api-ref-guides.html 2013-12-02 17:04:55 +01:00
.gitignore Setup for openstack-doc-tools gating 2014-01-02 17:00:03 +01:00
.gitreview Complete api-site split from openstack-manuals. 2012-09-25 10:20:38 -07:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README Setup for openstack-doc-tools gating 2014-01-02 17:00:03 +01:00
pom.xml Add parent pom for api-site and update to 1.12.0 2013-11-21 13:41:10 -06:00
test-requirements.txt Setup for openstack-doc-tools gating 2014-01-02 17:00:03 +01:00
tox.ini Setup for openstack-doc-tools gating 2014-01-02 17:00:03 +01:00

README 

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.