Add links to required Jenkins plugins in docs.

Add links to section docstrings that point at Jenkins plugins required
for that particular section to work.

Change-Id: Ie5c8de780072b157fbb873227d3ccfa5a2be88f3
Reviewed-on: https://review.openstack.org/13155
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

jenkins_jobs/modules/notifications.py

@@ -40,6 +40,8 @@ import jenkins_jobs.modules.base
 def http_endpoint(parser, xml_parent, data):
     """yaml: http
     Defines an HTTP notification endpoint.
+    Requires the Jenkins `Notification Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/Notification+Plugin>`_
 
     :arg str url: URL of the endpoint
 

jenkins_jobs/modules/properties.py

@@ -57,6 +57,8 @@ def github(parser, xml_parent, data):
 def throttle(parser, xml_parent, data):
     """yaml: throttle
     Throttles the number of builds for this job.
+    Requires the Jenkins `Throttle Concurrent Builds Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/Throttle+Concurrent+Builds+Plugin>`_
 
     :arg int max-per-node: max concurrent builds per node (default 0)
     :arg int max-total: max concurrent builds (default 0)
@@ -88,6 +90,8 @@ def throttle(parser, xml_parent, data):
 def inject(parser, xml_parent, data):
     """yaml: inject
     Allows you to inject evironment variables into the build.
+    Requires the Jenkins `Env Inject Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/EnvInject+Plugin>`_
 
     :arg str properties-file: file to read with properties (optional)
     :arg str properties-content: key=value properties (optional)

jenkins_jobs/modules/publishers.py

@@ -70,6 +70,8 @@ def archive(parser, xml_parent, data):
 def trigger_parameterized_builds(parser, xml_parent, data):
     """yaml: trigger-parameterized-builds
     Trigger parameterized builds of other jobs.
+    Requires the Jenkins `Parameterized Trigger Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/Parameterized+Trigger+Plugin>`_
 
     :arg str project: name of the job to trigger
     :arg str predefined-parameters: parameters to pass to the other
@@ -108,6 +110,8 @@ def trigger_parameterized_builds(parser, xml_parent, data):
 def coverage(parser, xml_parent, data):
     """yaml: coverage
     Generate a cobertura coverage report.
+    Requires the Jenkins `Cobertura Coverage Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/Cobertura+Plugin>`_
 
     Example::
 
@@ -172,6 +176,8 @@ def coverage(parser, xml_parent, data):
 def ftp(parser, xml_parent, data):
     """yaml: ftp
     Upload files via FTP.
+    Requires the Jenkins `Publish over FTP Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/Publish+Over+FTP+Plugin>`_
 
     :arg str site: name of the ftp site
     :arg str target: destination directory
@@ -264,6 +270,8 @@ def _violations_add_entry(xml_parent, name, data):
 def violations(parser, xml_parent, data):
     """yaml: violations
     Publish code style violations.
+    Requires the Jenkins `Violations Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/Violations>`_
 
     The violations component accepts any number of dictionaries keyed
     by the name of the violations system.  The dictionary has the
@@ -335,6 +343,8 @@ def violations(parser, xml_parent, data):
 def scp(parser, xml_parent, data):
     """yaml: scp
     Upload files via SCP
+    Requires the Jenkins `SCP Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/SCP+plugin>`_
 
     :arg str site: name of the scp site
     :arg str target: destination directory

jenkins_jobs/modules/scm.py

@@ -40,6 +40,8 @@ import jenkins_jobs.modules.base
 def git(self, xml_parent, data):
     """yaml: git
     Specifies the git SCM repository for this job.
+    Requires the Jenkins `Git Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin>`_
 
     :arg str url: URL of the git repository
     :arg list(str) branches: list of branch specifiers to build

jenkins_jobs/modules/triggers.py

@@ -37,6 +37,8 @@ import jenkins_jobs.modules.base
 def gerrit(parser, xml_parent, data):
     """yaml: gerrit
     Trigger on a Gerrit event.
+    Requires the Jenkins `Gerrit Trigger Plugin.
+    <wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger>`_
 
     :arg bool triggerOnPatchsetUploadedEvent: Trigger on patchset upload
     :arg bool triggerOnChangeMergedEvent: Trigger on change merged

jenkins_jobs/modules/wrappers.py

@@ -38,6 +38,8 @@ import jenkins_jobs.modules.base
 def timeout(parser, xml_parent, data):
     """yaml: timeout
     Abort the build if it runs too long.
+    Requires the Jenkins `Build Timeout Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/Build-timeout+Plugin>`_
 
     :arg int timeout: Abort the build after this number of minutes
     :arg bool fail: Mark the build as failed (default false)
@@ -64,6 +66,8 @@ def timeout(parser, xml_parent, data):
 def timestamps(parser, xml_parent, data):
     """yaml: timestamps
     Add timestamps to the console log.
+    Requires the Jenkins `Timestamper Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/Timestamper>`_
 
     Example::
 
@@ -77,6 +81,8 @@ def timestamps(parser, xml_parent, data):
 def ansicolor(parser, xml_parent, data):
     """yaml: ansicolor
     Translate ANSI color codes to HTML in the console log.
+    Requires the Jenkins `Ansi Color Plugin.
+    <https://wiki.jenkins-ci.org/display/JENKINS/AnsiColor+Plugin>`_
 
     Example::