a11016979d
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 one warning: * There is no source/_static dir so disable html_static_path 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 building [html]: targets for 18 source files that are out of date updating environment: 18 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 py-modindex 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: I55935fb5e869919ac639f841876aaf3871c71d17 Reviewed-on: https://review.openstack.org/16328 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 | ||
| jenkins_jobs | ||
| samples | ||
| tools | ||
| .gitignore | ||
| .gitreview | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| openstack-common.conf | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
README.rst
Jenkins Job Builder
Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format, and uses them to configure Jenkins. You can keep your job descriptions in human readable text format in a version control system to make changes and auditing easier. It also has a flexible template system, so creating many similarly configured jobs is easy.
To install:
$ sudo python setup.py installOnline documentation:
Developers
Bug report:
Cloning:
Patches are submitted via Gerrit at:
More details on how you can contribute is available on our wiki at:
Writing a patch
We ask that all code submissions be pep8 and pyflakes clean. The easiest way to do that is to run tox before submitting code for review in Gerrit. It will run pep8 and pyflakes in the same manner as the automated test suite that will run on proposed patchsets.
When creating new YAML components, please observe the following style conventions:
- All YAML identifiers (including component names and arguments) should be lower-case and multiple word identifiers should use hyphens. E.g., "build-trigger".
- The Python functions that implement components should have the same name as the YAML keyword, but should use underscores instead of hyphens. E.g., "build_trigger".
This consistency will help users avoid simple mistakes when writing YAML, as well as developers when matching YAML components to Python implementation.
Installing without setup.py
For YAML support, you will need libyaml installed.
Mac OS X:
$ brew install libyamlThen install the required python packages using pip:
$ sudo pip install PyYAML python-jenkins