From f1c02f85e1acf1a10f288c415f523b29fc513078 Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Mon, 23 Sep 2013 17:42:23 +0200 Subject: [PATCH] doc: fix up strict errors 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 --- doc/source/installation.rst | 2 +- jenkins_jobs/modules/publishers.py | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/source/installation.rst b/doc/source/installation.rst index fb811a096..d3f206f22 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -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. diff --git a/jenkins_jobs/modules/publishers.py b/jenkins_jobs/modules/publishers.py index 621a7a83b..98e7c2714 100644 --- a/jenkins_jobs/modules/publishers.py +++ b/jenkins_jobs/modules/publishers.py @@ -414,11 +414,12 @@ def jacoco(parser, xml_parent, data): `_ :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)