Fix documentation links

Jenkins Wiki has been fully taken off line, so update the remaining
links to reference either the relevant plugin page or the github repo.

Add extlink target for repo in jenkinsci github org.

The sonatype-clm plugin seems to be more-or-less completely deprecated,
so update the description to indicate this and link to the
nexus-artifact-uploader plugin.

Update the jjb sphinx plugin so that it generates references for the
yamlfunctions.

Change-Id: If2241e751d01a60a8cb4cbaea5b3176aeb92eab4
Signed-off-by: Pat Long <pllong@arista.com>

doc/source/conf.py

@@ -275,6 +275,7 @@ texinfo_documents = [
 extlinks = {
     "jenkins-wiki": ("https://wiki.jenkins.io/display/JENKINS/%s", None),
     "jenkins-plugins": ("https://plugins.jenkins.io/%s", None),
+    "jenkins-github": ("https://github.com/jenkinsci/%s", None),
 }
 
 linkcheck_ignore = [

doc/source/execution.rst

@@ -372,4 +372,4 @@ Command Reference
          can be overridden by setting the ``XDG_CACHE_HOME`` environment
          variable.
 .. [#f2] Jenkins Security Advisory affecting plugins info retrieval
-         https://wiki.jenkins.io/display/SECURITY/Jenkins+Security+Advisory+2016-05-11
+         https://www.jenkins.io/security/advisory/2016-05-11/#information-on-installed-plugins-exposed-via-api

jenkins_jobs/modules/builders.py

@@ -2218,7 +2218,7 @@ def grails(registry, xml_parent, data):
     """yaml: grails
     Execute a grails build step.
 
-    Requires the :jenkins-wiki:`Jenkins Grails Plugin <Grails+Plugin>`.
+    Requires the :jenkins-plugins:`Jenkins Grails Plugin <grails>`.
 
     :arg bool use-wrapper: Use a grails wrapper (default false)
     :arg str name: Select a grails installation to use (default '(Default)')
@@ -3337,8 +3337,12 @@ def xcode(registry, xml_parent, data):
 
 def sonatype_clm(registry, xml_parent, data):
     """yaml: sonatype-clm
-    Requires the Jenkins :jenkins-wiki:`Sonatype CLM Plugin
-    <Sonatype+CLM+%28formerly+Insight+for+CI%29>`.
+    Requires the Jenkins Sonatype CLM Plugin.
+
+    WARNING: This plugin appears to be deprecated. There does not seem
+    to be any place where it is available for download.
+
+    Try the :py:yamlfunction:`nexus-artifact-uploader` plugin instead.
 
     :arg str value: Select CLM application from a list of available CLM
         applications or specify CLM Application ID (default list)
@@ -4238,6 +4242,7 @@ def build_name_setter(registry, xml_parent, data):
 
 def nexus_artifact_uploader(registry, xml_parent, data):
     """yaml: nexus-artifact-uploader
+
     To upload result of a build as an artifact in Nexus without the need of
     Maven.
 

jenkins_jobs/modules/parameters.py

@@ -652,8 +652,8 @@ def dynamic_choice_param(registry, xml_parent, data):
     """yaml: dynamic-choice
     Dynamic Choice Parameter
 
-    Requires the Jenkins :jenkins-wiki:`Jenkins Dynamic Parameter Plug-in
-    <Dynamic+Parameter+Plug-in>`.
+    Requires the Jenkins :jenkins-plugins:`Jenkins Dynamic Parameter Plug-in
+    <dynamicparameter>`.
 
     :arg str name: the name of the parameter
     :arg str description: a description of the parameter (optional)
@@ -681,8 +681,8 @@ def dynamic_string_param(registry, xml_parent, data):
     """yaml: dynamic-string
     Dynamic Parameter
 
-    Requires the Jenkins :jenkins-wiki:`Jenkins Dynamic Parameter Plug-in
-    <Dynamic+Parameter+Plug-in>`.
+    Requires the Jenkins :jenkins-plugins:`Jenkins Dynamic Parameter Plug-in
+    <dynamicparameter>`.
 
     :arg str name: the name of the parameter
     :arg str description: a description of the parameter (optional)
@@ -710,8 +710,8 @@ def dynamic_choice_scriptler_param(registry, xml_parent, data):
     """yaml: dynamic-choice-scriptler
     Dynamic Choice Parameter (Scriptler)
 
-    Requires the Jenkins :jenkins-wiki:`Jenkins Dynamic Parameter Plug-in
-    <Dynamic+Parameter+Plug-in>`.
+    Requires the Jenkins :jenkins-plugins:`Jenkins Dynamic Parameter Plug-in
+    <dynamicparameter>`.
 
     :arg str name: the name of the parameter
     :arg str description: a description of the parameter (optional)
@@ -749,8 +749,8 @@ def dynamic_string_scriptler_param(registry, xml_parent, data):
     """yaml: dynamic-string-scriptler
     Dynamic Parameter (Scriptler)
 
-    Requires the Jenkins :jenkins-wiki:`Jenkins Dynamic Parameter Plug-in
-    <Dynamic+Parameter+Plug-in>`.
+    Requires the Jenkins :jenkins-plugins:`Jenkins Dynamic Parameter Plug-in
+    <dynamicparameter>`.
 
     :arg str name: the name of the parameter
     :arg str description: a description of the parameter (optional)
@@ -1200,8 +1200,8 @@ def active_choices_param(registry, xml_parent, data):
     """yaml: active-choices
     Active Choices Parameter
 
-    Requires the Jenkins :jenkins-wiki:`Active Choices Plug-in
-    <active+choices+plugin>`.
+    Requires the Jenkins :jenkins-plugins:`Active Choices Plug-in
+    <uno-choice>`.
 
     :arg str name: Name of the parameter (required).
     :arg str description: Description of the parameter.
@@ -1256,8 +1256,8 @@ def active_choices_reactive_param(registry, xml_parent, data):
     """yaml: active-choices-reactive
     Active Choices Reactive Parameter
 
-    Requires the Jenkins :jenkins-wiki:`Active Choices Plug-in
-    <active+choices+plugin>`.
+    Requires the Jenkins :jenkins-plugins:`Active Choices Plug-in
+    <uno-choice>`.
 
     :arg str name: Name of the parameter (required).
     :arg str description: Description of the parameter.
@@ -1349,8 +1349,8 @@ def dynamic_reference_param(registry, xml_parent, data):
     """yaml: dynamic-reference
     Active Choices Reactive Reference Parameter
 
-    Requires the Jenkins :jenkins-wiki:`Active Choices Plug-in
-    <active+choices+plugin>`.
+    Requires the Jenkins :jenkins-plugins:`Active Choices Plug-in
+    <uno-choice>`.
 
     :arg str name: Name of the parameter (required).
     :arg str description: Description of the parameter.

jenkins_jobs/modules/project_flow.py

@@ -19,7 +19,7 @@ The flow Project module handles creating Jenkins flow projects.
 You may specify ``flow`` in the ``project-type`` attribute of
 the :ref:`Job` definition.
 
-Requires the Jenkins :jenkins-wiki:`Build Flow Plugin <Build+Flow+Plugin>`.
+Requires the Jenkins :jenkins-plugins:`Build Flow Plugin <build-flow-plugin>`.
 
 In order to use it for job-template you have to escape the curly braces by
 doubling them in the DSL: { -> {{ , otherwise it will be interpreted by the

jenkins_jobs/modules/project_matrix.py

@@ -33,7 +33,7 @@ The module also supports additional, plugin-defined axes:
 * DynamicAxis (``dynamic``), requires the Jenkins
   :jenkins-plugins:`DynamicAxis Plugin <dynamic-axis>`
 * GroovyAxis (``groovy``), requires the Jenkins
-  :jenkins-wiki:`GroovyAxis Plugin <GroovyAxis>`
+  :jenkins-github:`GroovyAxis Plugin <groovyaxis-plugin>`
 * YamlAxis (``yaml``), requires the Jenkins
   :jenkins-plugins:`Yaml Axis Plugin <yaml-axis>`
 

jenkins_jobs/modules/properties.py

@@ -48,8 +48,8 @@ def builds_chain_fingerprinter(registry, xml_parent, data):
     """yaml: builds-chain-fingerprinter
     Builds chain fingerprinter.
 
-    Requires the Jenkins :jenkins-wiki:`Builds chain fingerprinter Plugin
-    <Builds+chain+fingerprinter>`.
+    Requires the Jenkins :jenkins-github:`Builds chain fingerprinter Plugin
+    <builds-chain-fingerprinter-plugin>`.
 
     :arg bool per-builds-chain: enable builds hierarchy fingerprinting
         (default false)

jenkins_jobs/modules/publishers.py

@@ -177,8 +177,8 @@ def blame_upstream(registry, xml_parent, data):
     """yaml: blame-upstream
     Notify upstream committers when build fails
 
-    Requires the Jenkins :jenkins-wiki:`Blame upstream committers Plugin
-    <Blame+Upstream+Committers+Plugin>`.
+    Requires the Jenkins :jenkins-github:`Blame Upstream Committers Plugin
+    <blame-upstream-commiters-plugin>`.
 
     Example:
 
@@ -1590,8 +1590,8 @@ def junit(registry, xml_parent, data):
     :arg bool claim-build: Allow claiming of failed tests (default false)
         Requires the Jenkins :jenkins-plugins:`Claim Plugin <claim>`.
     :arg bool measurement-plots: Create measurement plots (default false)
-        Requires the Jenkins :jenkins-wiki:`Measurement Plots Plugin
-        <Measurement+Plots+Plugin>`.
+        Requires the Jenkins :jenkins-github:`Measurement Plots Plugin
+        <measurement-plots-plugin>`.
     :arg bool flaky-test-reports: Publish flaky test reports (default false).
         Requires the Jenkins :jenkins-plugins:`Flaky Test Handler Plugin
         <flaky-test-handler>`.
@@ -2818,8 +2818,8 @@ def aggregate_flow_tests(registry, xml_parent, data):
     """yaml: aggregate-flow-tests
     Aggregate downstream test results in a Build Flow job.
 
-    Requires the Jenkins :jenkins-wiki:`Build Flow Test Aggregator Plugin
-    <Build+Flow+Test+Aggregator+Plugin>`.
+    Requires the Jenkins `Build Flow Test Aggregator Plugin
+    <https://github.com/zeroturnaround/build-flow-test-aggregator>`_.
 
     :arg bool show-test-results-trend: whether to show test results
         trend graph (default true)
@@ -3010,8 +3010,7 @@ def copy_to_master(registry, xml_parent, data):
     """yaml: copy-to-master
     Copy files to master from slave.
 
-    Requires the Jenkins :jenkins-wiki:`Copy To Slave Plugin
-    <Copy+To+Slave+Plugin>`.
+    Requires the Jenkins :jenkins-plugins:`Copy To Slave Plugin <copy-to-slave>`.
 
     :arg list includes: list of file patterns to copy
     :arg list excludes: list of file patterns to exclude

jenkins_jobs/modules/triggers.py

@@ -2182,8 +2182,7 @@ def script(registry, xml_parent, data):
     """yaml: script
     Triggers the job using shell or batch script.
 
-    Requires the Jenkins :jenkins-wiki:`ScriptTrigger Plugin
-    <ScriptTrigger+Plugin>`.
+    Requires the Jenkins :jenkins-plugins:`ScriptTrigger Plugin <scripttrigger>`.
 
     :arg str label: Restrict where the polling should run. (default '')
     :arg str script: A shell or batch script. (default '')
@@ -2223,8 +2222,8 @@ def groovy_script(registry, xml_parent, data):
     """yaml: groovy-script
     Triggers the job using a groovy script.
 
-    Requires the Jenkins :jenkins-wiki:`ScriptTrigger Plugin
-    <ScriptTrigger+Plugin>`.
+    Requires the Jenkins :jenkins-plugins:`ScriptTrigger Plugin
+    <scripttrigger>`.
 
     :arg bool system-script: If true, run the groovy script as a system script,
       the script will have access to the same variables as the Groovy Console.

jenkins_jobs/modules/wrappers.py

@@ -1138,8 +1138,8 @@ def locks(registry, xml_parent, data):
     """yaml: locks
     Control parallel execution of jobs.
 
-    Requires the Jenkins :jenkins-wiki:`Locks and Latches Plugin
-    <Locks+and+Latches+plugin>`.
+    Requires the Jenkins :jenkins-github:`Locks and Latches Plugin
+    <locks-and-latches-plugin>`.
 
     :arg: list of locks to use
 
@@ -1163,8 +1163,7 @@ def copy_to_slave(registry, xml_parent, data):
     """yaml: copy-to-slave
     Copy files to slave before build.
 
-    Requires the Jenkins :jenkins-wiki:`Copy To Slave Plugin
-    <Copy+To+Slave+Plugin>`.
+    Requires the Jenkins :jenkins-plugins:`Copy To Slave Plugin <copy-to-slave>`.
 
     :arg list includes: list of file patterns to copy (optional)
     :arg list excludes: list of file patterns to exclude (optional)

jenkins_jobs/sphinx/yaml.py

@@ -23,7 +23,7 @@ import re
 
 from sphinx import addnodes
 from sphinx.domains.python import _pseudo_parse_arglist
-from sphinx.domains.python import PyModulelevel
+from sphinx.domains.python import PyModulelevel, PyXRefRole
 from sphinx.ext.autodoc import Documenter
 from sphinx.ext.autodoc import FunctionDocumenter
 from sphinx.locale import _
@@ -142,3 +142,4 @@ class YAMLFunctionDocumenter(FunctionDocumenter):
 def setup(app):
     app.add_autodocumenter(YAMLFunctionDocumenter)
     app.add_directive_to_domain("py", "yamlfunction", PyYAMLFunction)
+    app.add_role_to_domain("py", "yamlfunction", PyXRefRole())