d06f2a6728
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 |
||
|---|---|---|
| doc | ||
| etc | ||
| tests | ||
| tools | ||
| zuul | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| LICENSE | ||
| MANIFEST.in | ||
| README | ||
| openstack-common.conf | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
README
# 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