Documentation fixes to make Sphinx happy

On this note, we have an issue with our current gate test for
documentation not properly catching these issues.  I'll be attempting to
address the issue in a future patch.

Change-Id: I7d0bea70ef98d1744200815ce12f1436729349e8
Signed-off-by: Paul Belanger <paul.belanger@polybeacon.com>
Reviewed-on: https://review.openstack.org/19889
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Reviewed-by: James E. Blair <corvus@inaugust.com>
Approved: James E. Blair <corvus@inaugust.com>
Tested-by: Jenkins
This commit is contained in:
Paul Belanger
2013-01-16 22:18:27 -05:00
committed by Jenkins
parent ff734c72dc
commit 656915f66d
3 changed files with 16 additions and 12 deletions

View File

@@ -259,6 +259,8 @@ the generic macro ``add``. Whenever you forget a parameter from a macro,
it will not be expanded and left as is, which will most probably cause havoc in
your Jenkins builds.
.. _defaults:
Defaults
^^^^^^^^

View File

@@ -28,9 +28,9 @@ later. There are a few basic optional fields for a Job definition::
Defaults to "freestyle", but "maven" can also be specified.
* **defaults**:
Specifies a set of `Defaults`_ to use for this job, defaults to
Specifies a set of :ref:`defaults` to use for this job, defaults to
''global''. If you have values that are common to all of your jobs,
create a ``global`` `Defaults`_ object to hold them, and no further
create a ``global`` :ref:`defaults` object to hold them, and no further
configuration of individual jobs is necessary. If some jobs
should not use the ``global`` defaults, use this field to specify a
different set of defaults.

View File

@@ -276,6 +276,7 @@ def inject(parser, xml_parent, data):
:arg str script-content: contents of a script (default '')
Example::
wrappers:
- inject:
properties-file-path: /usr/local/foo
@@ -309,18 +310,19 @@ def jclouds(parser, xml_parent, data):
the instance (default: False).
Example::
wrappers:
- jclouds:
single-use: True
instances:
- jenkins-dev-slave:
cloud-name: mycloud1
count: 1
stop-on-terminate: True
- jenkins-test-slave:
cloud-name: mycloud2
count: 2
stop-on-terminate: False
single-use: True
instances:
- jenkins-dev-slave:
cloud-name: mycloud1
count: 1
stop-on-terminate: True
- jenkins-test-slave:
cloud-name: mycloud2
count: 2
stop-on-terminate: False
"""
buildWrapper = XML.SubElement(xml_parent,
'jenkins.plugins.jclouds.compute.'