Merge "Fix references to examples in api documentation"

This commit is contained in:
Jenkins 2014-01-28 02:23:09 +00:00 committed by Gerrit Code Review
commit 704bc0d625
4 changed files with 12 additions and 11 deletions

View File

@ -740,7 +740,7 @@ def maven_target(parser, xml_parent, data):
Example: Example:
.. literalinclude:: ../../tests/builders/fixtures/maven-target-doc.yaml .. literalinclude:: /../../tests/builders/fixtures/maven-target-doc.yaml
""" """
maven = XML.SubElement(xml_parent, 'hudson.tasks.Maven') maven = XML.SubElement(xml_parent, 'hudson.tasks.Maven')
XML.SubElement(maven, 'targets').text = data['goals'] XML.SubElement(maven, 'targets').text = data['goals']

View File

@ -451,7 +451,7 @@ def batch_tasks(parser, xml_parent, data):
Example: Example:
.. literalinclude:: ../../tests/properties/fixtures/batch-task.yaml .. literalinclude:: /../../tests/properties/fixtures/batch-task.yaml
""" """
pdef = XML.SubElement(xml_parent, pdef = XML.SubElement(xml_parent,

View File

@ -99,7 +99,7 @@ def emotional_jenkins(parser, xml_parent, data):
Example: Example:
.. literalinclude:: ../../tests/publishers/fixtures/emotional-jenkins.yaml .. literalinclude:: /../../tests/publishers/fixtures/emotional-jenkins.yaml
""" """
XML.SubElement(xml_parent, XML.SubElement(xml_parent,
'org.jenkinsci.plugins.emotional__jenkins.' 'org.jenkinsci.plugins.emotional__jenkins.'
@ -288,11 +288,11 @@ def cloverphp(parser, xml_parent, data):
Minimal example: Minimal example:
.. literalinclude:: ../../tests/publishers/fixtures/cloverphp001.yaml .. literalinclude:: /../../tests/publishers/fixtures/cloverphp001.yaml
Full example: Full example:
.. literalinclude:: ../../tests/publishers/fixtures/cloverphp002.yaml .. literalinclude:: /../../tests/publishers/fixtures/cloverphp002.yaml
""" """
cloverphp = XML.SubElement( cloverphp = XML.SubElement(
@ -1089,7 +1089,7 @@ def scp(parser, xml_parent, data):
Example: Example:
.. literalinclude:: ../../tests/publishers/fixtures/scp001.yaml .. literalinclude:: /../../tests/publishers/fixtures/scp001.yaml
""" """
site = data['site'] site = data['site']
scp = XML.SubElement(xml_parent, scp = XML.SubElement(xml_parent,
@ -1178,7 +1178,7 @@ def pipeline(parser, xml_parent, data):
Example: Example:
.. literalinclude:: ../../tests/publishers/fixtures/pipeline002.yaml .. literalinclude:: /../../tests/publishers/fixtures/pipeline002.yaml
You can build pipeline jobs that are re-usable in different pipelines by You can build pipeline jobs that are re-usable in different pipelines by
@ -2987,7 +2987,7 @@ def github_notifier(parser, xml_parent, data):
Example: Example:
.. literalinclude:: ../../tests/publishers/fixtures/github-notifier.yaml .. literalinclude:: /../../tests/publishers/fixtures/github-notifier.yaml
""" """
XML.SubElement(xml_parent, XML.SubElement(xml_parent,
'com.cloudbees.jenkins.GitHubCommitNotifier') 'com.cloudbees.jenkins.GitHubCommitNotifier')
@ -3057,7 +3057,7 @@ def stash(parser, xml_parent, data):
Example: Example:
.. literalinclude:: ../../tests/publishers/fixtures/stash001.yaml .. literalinclude:: /../../tests/publishers/fixtures/stash001.yaml
""" """
top = XML.SubElement(xml_parent, top = XML.SubElement(xml_parent,
@ -3092,7 +3092,8 @@ def description_setter(parser, xml_parent, data):
Example: Example:
.. literalinclude:: ../../tests/publishers/fixtures/description-setter.yaml .. literalinclude::
/../../tests/publishers/fixtures/description-setter.yaml
""" """

View File

@ -363,7 +363,7 @@ def github_pull_request(parser, xml_parent, data):
Example: Example:
.. literalinclude:: ../../tests/triggers/fixtures/github-pull-request.yaml .. literalinclude:: /../../tests/triggers/fixtures/github-pull-request.yaml
""" """
ghprb = XML.SubElement(xml_parent, 'org.jenkinsci.plugins.ghprb.' ghprb = XML.SubElement(xml_parent, 'org.jenkinsci.plugins.ghprb.'
'GhprbTrigger') 'GhprbTrigger')