The Gatekeeper, or a project gating system
Go to file
Antoine Musso d06f2a6728 sphinx is now stricter
The documentation files often have minor typo or badly formatted
commands which makes sphinx emits a warning. To make sure we always
catch them via the Jenkins build, this patch makes sphinx to convert
warning to errors thus aborting the build, simply add to pass the -W
option to sphinx-build.

This patch also fix some warnings:
* There is no source/_static dir so disable html_static_path
* In launchers.rst, File reference name should be before the title

Test plan:

$ make clean; make html
rm -rf build/*
sphinx-build -b html -d build/doctrees  -W source build/html
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
loading intersphinx inventory from
http://docs.python.org/2.7/objects.inv...
building [html]: targets for 5 source files that are out of date
updating environment: 5 added, 0 changed, 0 removed
reading sources... [100%] zuul
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] zuul
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded.

Build finished. The HTML pages are in build/html.
$

Change-Id: Id907cc2c9aeccd077593b2fa1b78b220a159ed71
Reviewed-on: https://review.openstack.org/16316
Reviewed-by: Paul Belanger <paul.belanger@polybeacon.com>
Reviewed-by: Monty Taylor <mordred@inaugust.com>
Reviewed-by: Jeremy Stanley <fungi@yuggoth.org>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Approved: Clark Boylan <clark.boylan@gmail.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Tested-by: Jenkins
2013-01-15 18:35:53 +00:00
doc sphinx is now stricter 2013-01-15 18:35:53 +00:00
etc filter events by user email 2012-12-18 15:47:16 +00:00
tests Make report message introduction configurable. 2013-01-15 01:19:08 +00:00
tools Add layout file validation. 2013-01-15 01:17:47 +00:00
zuul Make report message introduction configurable. 2013-01-15 01:19:08 +00:00
.gitignore Add layout file validation. 2013-01-15 01:17:47 +00:00
.gitreview Updated .gitreview location 2012-12-16 20:34:13 +00:00
.mailmap Fix pep8 E127 violations 2012-09-26 14:23:10 +00:00
LICENSE Initial commit. 2012-05-29 14:49:32 -07:00
MANIFEST.in Import oslo-incubator for versioning 2012-11-17 01:32:14 +00:00
openstack-common.conf Import oslo-incubator for versioning 2012-11-17 01:32:14 +00:00
README Update README for project move. 2012-12-16 20:34:22 +00:00
setup.cfg Restrict test coverage to the zuul package. 2012-09-10 20:06:36 +00:00
setup.py Use entrypoints for zuul-server. 2012-11-27 00:44:41 +00:00
tox.ini Fix exception calculating run time for lost builds. 2013-01-01 01:25:19 +00:00

# Zuul

Zuul is a trunk gating system developed for the OpenStack Project.

## Contributing

To get the latest code, see: https://github.com/openstack-infra/zuul

Bugs are handled at: https://launchpad.net/zuul

Code reviews are, as you might expect, handled by gerrit. The gerrit they
use is http://review.openstack.org

Use `git review` to submit patches (after creating a gerrit account that links to your launchpad account). Example:

    # Do your commits
    git review
    # Enter your username if promped