jjb/jenkins-job-builder
Code Issues Proposed changes

doc: fix up strict errors

Browse Source 
Running Sphinx 1.2b1 running in strict mode (-W), yields three different
errors:

* .. Running::   is an unknown command, uses '.. rubric::' instead
* double stars '**' needs either to be escaped with backslashes or
  quoted literrally with double backquotes
* nested lists needs newlines before and after for some reason.

Change-Id: I8680aef7306c619c817c637882715f5a7d08c5d9
This commit is contained in:
Antoine Musso 2013-09-23 17:42:23 +02:00
parent 7acf012c2b
commit f1c02f85e1
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/installation.rst
View File

@ -80,6 +80,6 @@ arguments after the configuration path. To update Foo1 and Foo2 run::
jenkins-jobs update /path/to/config Foo1 Foo2
.. Running:: Footnotes
.. rubric:: Footnotes
.. [#f1] The cache default location is at ``~/.cache/jenkins_jobs``, which
can be overriden by setting the ``XDG_CACHE_HOME`` environment variable.

9
jenkins_jobs/modules/publishers.py
View File

@ -414,11 +414,12 @@ def jacoco(parser, xml_parent, data):
<https://wiki.jenkins-ci.org/display/JENKINS/JaCoCo+Plugin>`_
:arg str exec-pattern: This is a file name pattern that can be used to
locate the jacoco report files (default '**/**.exec')
locate the jacoco report files (default
``**/**.exec``)
:arg str class-pattern: This is a file name pattern that can be used
to locate class files (default '**/classes')
to locate class files (default ``**/classes``)
:arg str source-pattern: This is a file name pattern that can be used
to locate source files (default '**/src/main/java')
to locate source files (default ``**/src/main/java``)
:arg bool update-build-status: Update the build according to the results
(default False)
:arg str inclusion-pattern: This is a file name pattern that can be used
@ -2552,11 +2553,13 @@ def plot(parser, xml_parent, data):
:Serie: * **file** (`str`) : files to include
* **inclusion-flag** filtering mode for CSV files. Possible
values are:
* **off** (default)
* **include-by-string**
* **exclude-by-string**
* **include-by-column**
* **exclude-by-column**
* **exclude** (`str`) : exclude pattern for CSV file.
* **url** (`str`) : for 'csv' and 'xml' file types
used when you click on a point (default: empty)