Browse Source

docs: sphinx upgrade and warnings as erros

Change-Id: I455ac0d79cca3883d3a758a2709c8c0255f4cc7d
tags/2.0.2
Sorin Sbarnea 1 year ago
parent
commit
d8ace6802d

+ 2
- 2
doc/source/view_list.rst View File

@@ -1,7 +1,7 @@
1
-.. view_list:
1
+.. _view_list:
2 2
 
3 3
 List View
4 4
 =========
5 5
 
6 6
 .. automodule:: view_list
7
-   :members:
7
+  :members:

+ 2
- 2
doc/source/view_pipeline.rst View File

@@ -1,7 +1,7 @@
1
-.. view_pipeline:
1
+.. _view_pipeline:
2 2
 
3 3
 Pipeline View
4 4
 =============
5 5
 
6 6
 .. automodule:: view_pipeline
7
-   :members:
7
+  :members:

+ 1
- 1
doc/source/wrappers.rst View File

@@ -4,4 +4,4 @@ Wrappers
4 4
 ========
5 5
 
6 6
 .. automodule:: wrappers
7
-   :members:
7
+  :members:

+ 1
- 1
doc/source/zuul.rst View File

@@ -4,4 +4,4 @@ Zuul
4 4
 ====
5 5
 
6 6
 .. automodule:: zuul
7
-   :members:
7
+  :members:

+ 3
- 2
jenkins_jobs/modules/base.py View File

@@ -54,8 +54,9 @@ class Base(object):
54 54
         return ``True``, otherwise, it must return ``False``.
55 55
 
56 56
         :arg dict job_data: the intermediate representation of job data
57
-        loaded from JJB Yaml files without variables interpolation or other
58
-        yaml expansions.
57
+            loaded from JJB Yaml files without variables interpolation or other
58
+            yaml expansions.
59
+
59 60
         :rtype: boolean
60 61
         """
61 62
 

+ 3
- 1
jenkins_jobs/modules/builders.py View File

@@ -3779,10 +3779,12 @@ def docker_build_publish(parse, xml_parent, data):
3779 3779
     :arg str repo-name: Name of repository to push to.
3780 3780
     :arg str repo-tag: Tag for image. (default '')
3781 3781
     :arg dict server: The docker daemon (optional)
3782
+
3782 3783
         * **uri** (str): Define the docker server to use. (optional)
3783 3784
         * **credentials-id** (str): ID of credentials to use to connect
3784 3785
           (optional)
3785 3786
     :arg dict registry: Registry to push to
3787
+
3786 3788
         * **url** (str) repository url to use (optional)
3787 3789
         * **credentials-id** (str): ID of credentials to use to connect
3788 3790
           (optional)
@@ -3922,7 +3924,7 @@ def nexus_artifact_uploader(registry, xml_parent, data):
3922 3924
     File Example:
3923 3925
 
3924 3926
     .. literalinclude::
3925
-        /../../tests/builders/fixtures/nexus-artifact-uploader.yaml
3927
+        /../../tests/builders/fixtures/nexus_artifact_uploader001.yaml
3926 3928
        :language: yaml
3927 3929
     """
3928 3930
     nexus_artifact_uploader = XML.SubElement(

+ 10
- 9
jenkins_jobs/modules/parameters.py View File

@@ -309,9 +309,9 @@ def credentials_param(registry, xml_parent, data):
309 309
 
310 310
     Example::
311 311
 
312
-    .. literalinclude:: \
313
-       /../../tests/parameters/fixtures/credentials-param001.yaml
314
-       :language: yaml
312
+        .. literalinclude::
313
+            /../../tests/parameters/fixtures/credentials-param001.yaml
314
+           :language: yaml
315 315
 
316 316
     """
317 317
     cred_impl_types = {
@@ -398,14 +398,15 @@ def extended_choice_param(registry, xml_parent, data):
398 398
 
399 399
     Minimal Example:
400 400
 
401
-    .. literalinclude:: \
402
-    /../../tests/parameters/fixtures/extended-choice-param-minimal.yaml
403
-       :language: yaml
401
+        .. literalinclude:: \
402
+        /../../tests/parameters/fixtures/extended-choice-param-minimal.yaml
403
+           :language: yaml
404 404
 
405 405
     Full Example:
406
-    .. literalinclude:: \
407
-    /../../tests/parameters/fixtures/extended-choice-param-full.yaml
408
-       :language: yaml
406
+
407
+        .. literalinclude:: \
408
+        /../../tests/parameters/fixtures/extended-choice-param-full.yaml
409
+           :language: yaml
409 410
     """
410 411
     pdef = base_param(registry, xml_parent, data, False,
411 412
                       'com.cwctravel.hudson.plugins.'

+ 7
- 11
jenkins_jobs/modules/properties.py View File

@@ -291,23 +291,19 @@ def branch_api(registry, xml_parent, data):
291 291
     :arg str time-period: The time period within which the maximum number
292 292
         of builds will be enforced. (default 'Hour')
293 293
 
294
-        :valid values:
295
-        * **Hour**
296
-        * **Day**
297
-        * **Week**
298
-        * **Month**
299
-        * **Year**
294
+        :valid values: **Hour**, **Day**, **Week**, **Month**, **Year**
300 295
 
301 296
     Minimal Example:
302 297
 
303
-    .. literalinclude::
304
-       /../../tests/properties/fixtures/branch-api-minimal.yaml
305
-       :language: yaml
298
+        .. literalinclude::
299
+           /../../tests/properties/fixtures/branch-api-minimal.yaml
300
+           :language: yaml
306 301
 
307 302
     Full example:
308 303
 
309
-    .. literalinclude:: /../../tests/properties/fixtures/branch-api-full.yaml
310
-       :language: yaml
304
+        .. literalinclude::
305
+           /../../tests/properties/fixtures/branch-api-full.yaml
306
+           :language: yaml
311 307
     """
312 308
     branch = XML.SubElement(xml_parent, 'jenkins.branch.'
313 309
                             'RateLimitBranchProperty_-JobPropertyImpl')

+ 128
- 109
jenkins_jobs/modules/publishers.py View File

@@ -48,23 +48,24 @@ def allure(registry, xml_parent, data):
48 48
 
49 49
     :arg str jdk: String identifier for a JDK installation in Jenkins
50 50
     :arg str commandline: String identifier for a Allure-commandline tool
51
-    installation
51
+        installation
52 52
     :arg str report-build-policy: String identifier for a report build
53
-     policy enum. Possible values: 'ALWAYS', 'UNSTABLE', 'UNSUCCESSFUL'.
54
-      (By default is 'ALWAYS')
53
+        policy enum. Possible values: 'ALWAYS', 'UNSTABLE', 'UNSUCCESSFUL'.
54
+        (By default is 'ALWAYS')
55 55
     :arg bool include-properties: Flag to include specified properties
56 56
     :arg list results-paths: List of results directories
57 57
     :arg list properties: List of key:value property pairs
58 58
 
59 59
     Minimal Example:
60 60
 
61
-    .. literalinclude:: /../../tests/publishers/fixtures/allure-minimal.yaml
62
-       :language: yaml
61
+        .. literalinclude::
62
+           /../../tests/publishers/fixtures/allure-minimal.yaml
63
+           :language: yaml
63 64
 
64 65
     Full Example:
65 66
 
66
-    .. literalinclude:: /../../tests/publishers/fixtures/allure-full.yaml
67
-       :language: yaml
67
+        .. literalinclude:: /../../tests/publishers/fixtures/allure-full.yaml
68
+           :language: yaml
68 69
 
69 70
     """
70 71
     publisher_class = 'ru.yandex.qatools.allure.jenkins.AllureReportPublisher'
@@ -127,8 +128,8 @@ def archive(registry, xml_parent, data):
127 128
 
128 129
     Example:
129 130
 
130
-    .. literalinclude::  /../../tests/publishers/fixtures/archive001.yaml
131
-       :language: yaml
131
+        .. literalinclude::  /../../tests/publishers/fixtures/archive001.yaml
132
+           :language: yaml
132 133
     """
133 134
     archiver = XML.SubElement(xml_parent, 'hudson.tasks.ArtifactArchiver')
134 135
     mapping = [
@@ -153,8 +154,8 @@ def blame_upstream(registry, xml_parent, data):
153 154
 
154 155
     Example:
155 156
 
156
-    .. literalinclude::  /../../tests/publishers/fixtures/blame001.yaml
157
-       :language: yaml
157
+        .. literalinclude::  /../../tests/publishers/fixtures/blame001.yaml
158
+           :language: yaml
158 159
     """
159 160
 
160 161
     XML.SubElement(xml_parent,
@@ -178,7 +179,7 @@ def jclouds(registry, xml_parent, data):
178 179
 
179 180
     Example:
180 181
 
181
-    .. literalinclude::  /../../tests/publishers/fixtures/jclouds001.yaml
182
+        .. literalinclude::  /../../tests/publishers/fixtures/jclouds001.yaml
182 183
 
183 184
     """
184 185
 
@@ -224,8 +225,8 @@ def javadoc(registry, xml_parent, data):
224 225
 
225 226
     Example:
226 227
 
227
-    .. literalinclude::  /../../tests/publishers/fixtures/javadoc001.yaml
228
-       :language: yaml
228
+        .. literalinclude::  /../../tests/publishers/fixtures/javadoc001.yaml
229
+           :language: yaml
229 230
     """
230 231
 
231 232
     root = XML.SubElement(xml_parent, 'hudson.tasks.JavadocArchiver')
@@ -246,8 +247,8 @@ def jdepend(registry, xml_parent, data):
246 247
 
247 248
     Example:
248 249
 
249
-    .. literalinclude::  /../../tests/publishers/fixtures/jdepend001.yaml
250
-       :language: yaml
250
+        .. literalinclude::  /../../tests/publishers/fixtures/jdepend001.yaml
251
+           :language: yaml
251 252
     """
252 253
     jdepend = XML.SubElement(
253 254
         xml_parent,
@@ -273,13 +274,15 @@ def hue_light(registry, xml_parent, data):
273 274
 
274 275
     Full Example:
275 276
 
276
-    .. literalinclude:: /../../tests/publishers/fixtures/hue-light-full.yaml
277
-       :language: yaml
277
+        .. literalinclude::
278
+           /../../tests/publishers/fixtures/hue-light-full.yaml
279
+           :language: yaml
278 280
 
279 281
     Minimal Example:
280 282
 
281
-    .. literalinclude:: /../../tests/publishers/fixtures/hue-light-minimal.yaml
282
-       :language: yaml
283
+        .. literalinclude::
284
+           /../../tests/publishers/fixtures/hue-light-minimal.yaml
285
+           :language: yaml
283 286
     """
284 287
 
285 288
     hue_light = XML.SubElement(
@@ -317,8 +320,8 @@ def campfire(registry, xml_parent, data):
317 320
 
318 321
     Example:
319 322
 
320
-    .. literalinclude::  /../../tests/publishers/fixtures/campfire001.yaml
321
-       :language: yaml
323
+        .. literalinclude::  /../../tests/publishers/fixtures/campfire001.yaml
324
+           :language: yaml
322 325
     """
323 326
 
324 327
     root = XML.SubElement(xml_parent,
@@ -350,23 +353,23 @@ def mqtt(registry, xml_parent, data):
350 353
 
351 354
     :arg str broker-url: the broker URL, as protocol://address:port (required)
352 355
     :arg str credentials-id: credentials to use to connect to the broker
353
-    (optional)
356
+        (optional)
354 357
     :arg str topic: the message topic (default "jenkins/$PROJECT_URL")
355 358
     :arg str message: the message itself (default "$BUILD_RESULT")
356 359
     :arg str qos: one of AT_MOST_ONCE, AT_LEAST_ONCE, or EXACTLY_ONCE
357
-    (default AT_MOST_ONCE)
360
+        (default AT_MOST_ONCE)
358 361
     :arg bool retain-message: whether to resend message or not when a new
359
-    client connects (default false)
362
+        client connects (default false)
360 363
 
361 364
     Minimal Example:
362 365
 
363
-    .. literalinclude:: /../../tests/publishers/fixtures/mqtt-minimal.yaml
364
-       :language: yaml
366
+        .. literalinclude:: /../../tests/publishers/fixtures/mqtt-minimal.yaml
367
+           :language: yaml
365 368
 
366 369
     Full Example:
367 370
 
368
-    .. literalinclude:: /../../tests/publishers/fixtures/mqtt-full.yaml
369
-       :language: yaml
371
+        .. literalinclude:: /../../tests/publishers/fixtures/mqtt-full.yaml
372
+           :language: yaml
370 373
     """
371 374
 
372 375
     mqtt = XML.SubElement(xml_parent,
@@ -407,13 +410,15 @@ def codecover(registry, xml_parent, data):
407 410
 
408 411
     Minimal Example:
409 412
 
410
-    .. literalinclude:: /../../tests/publishers/fixtures/codecover-minimal.yaml
411
-       :language: yaml
413
+        .. literalinclude::
414
+           /../../tests/publishers/fixtures/codecover-minimal.yaml
415
+           :language: yaml
412 416
 
413 417
     Full Example:
414 418
 
415
-    .. literalinclude:: /../../tests/publishers/fixtures/codecover-full.yaml
416
-       :language: yaml
419
+        .. literalinclude::
420
+           /../../tests/publishers/fixtures/codecover-full.yaml
421
+           :language: yaml
417 422
     """
418 423
 
419 424
     codecover = XML.SubElement(
@@ -447,8 +452,9 @@ def emotional_jenkins(registry, xml_parent, data):
447 452
 
448 453
     Example:
449 454
 
450
-    .. literalinclude:: /../../tests/publishers/fixtures/emotional-jenkins.yaml
451
-       :language: yaml
455
+        .. literalinclude::
456
+           /../../tests/publishers/fixtures/emotional-jenkins.yaml
457
+           :language: yaml
452 458
     """
453 459
     XML.SubElement(xml_parent,
454 460
                    'org.jenkinsci.plugins.emotional__jenkins.'
@@ -521,12 +527,12 @@ def trigger_parameterized_builds(registry, xml_parent, data):
521 527
 
522 528
     Example:
523 529
 
524
-    .. literalinclude::
525
-        /../../tests/publishers/fixtures/trigger_parameterized_builds001.yaml
526
-       :language: yaml
527
-    .. literalinclude::
528
-        /../../tests/publishers/fixtures/trigger_parameterized_builds003.yaml
529
-       :language: yaml
530
+        .. literalinclude::
531
+            /../../tests/publishers/fixtures/trigger_parameterized_builds001.yaml
532
+           :language: yaml
533
+        .. literalinclude::
534
+            /../../tests/publishers/fixtures/trigger_parameterized_builds003.yaml
535
+           :language: yaml
530 536
     """
531 537
     pt_prefix = 'hudson.plugins.parameterizedtrigger.'
532 538
     tbuilder = XML.SubElement(xml_parent, pt_prefix + 'BuildTrigger')
@@ -931,11 +937,11 @@ def jacoco(registry, xml_parent, data):
931 937
     Requires the Jenkins :jenkins-wiki:`JaCoCo Plugin <JaCoCo+Plugin>`.
932 938
 
933 939
     :arg str exec-pattern: This is a file name pattern that can be used to
934
-        locate the jacoco report files (default '**/**.exec')
940
+        locate the jacoco report files (default ``**/**.exec``)
935 941
     :arg str class-pattern: This is a file name pattern that can be used
936
-        to locate class files (default '**/classes')
942
+        to locate class files (default ``**/classes``)
937 943
     :arg str source-pattern: This is a file name pattern that can be used
938
-        to locate source files (default '**/src/main/java')
944
+        to locate source files (default ``**/src/main/java``)
939 945
     :arg bool update-build-status: Update the build according to the results
940 946
         (default false)
941 947
     :arg str inclusion-pattern: This is a file name pattern that can be used
@@ -2178,15 +2184,18 @@ def cppcheck(registry, xml_parent, data):
2178 2184
             is also determined by thresholds. If the actual number of issues
2179 2185
             is between the provided thresholds, then the build health is
2180 2186
             interpolated.
2187
+
2181 2188
         * **unstable** (`str`): Total number unstable threshold (default '')
2182 2189
         * **new-unstable** (`str`): New number unstable threshold (default '')
2183 2190
         * **failure** (`str`): Total number failure threshold (default '')
2184 2191
         * **new-failure** (`str`): New number failure threshold (default '')
2185 2192
         * **healthy** (`str`): Healthy threshold (default '')
2186 2193
         * **unhealthy** (`str`): Unhealthy threshold (default '')
2194
+
2187 2195
     :arg dict severity:
2188 2196
         :severity: Determines which severity of issues should be considered
2189 2197
             when evaluating the build status and health, default all true
2198
+
2190 2199
         * **error** (`bool`): Severity error (default true)
2191 2200
         * **warning** (`bool`): Severity warning (default true)
2192 2201
         * **style** (`bool`): Severity style (default true)
@@ -2194,12 +2203,16 @@ def cppcheck(registry, xml_parent, data):
2194 2203
         * **information** (`bool`): Severity information (default true)
2195 2204
         * **nocategory** (`bool`): Severity nocategory (default true)
2196 2205
         * **portability** (`bool`): Severity portability (default true)
2206
+
2197 2207
     :arg dict graph:
2198 2208
         :graph: Graph configuration
2209
+
2199 2210
         * **xysize** (`array`): Chart width and height (default [500, 200])
2200 2211
         * **num-builds-in-graph** (`int`): Builds number in graph (default 0)
2212
+
2201 2213
     :arg dict display
2202 2214
         :display: which errors to display, default only sum
2215
+
2203 2216
         * **sum** (`bool`): Display sum of all issues (default true)
2204 2217
         * **error** (`bool`): Display errors (default false)
2205 2218
         * **warning** (`bool`): Display warnings (default false)
@@ -2211,14 +2224,15 @@ def cppcheck(registry, xml_parent, data):
2211 2224
 
2212 2225
     Minimal Example:
2213 2226
 
2214
-    .. literalinclude::
2215
-        /../../tests/publishers/fixtures/cppcheck-minimal.yaml
2216
-       :language: yaml
2227
+        .. literalinclude::
2228
+            /../../tests/publishers/fixtures/cppcheck-minimal.yaml
2229
+           :language: yaml
2217 2230
 
2218 2231
     Full Example:
2219
-    .. literalinclude::
2220
-        /../../tests/publishers/fixtures/cppcheck-full.yaml
2221
-       :language: yaml
2232
+
2233
+        .. literalinclude::
2234
+            /../../tests/publishers/fixtures/cppcheck-full.yaml
2235
+           :language: yaml
2222 2236
     """
2223 2237
 
2224 2238
     cppextbase = XML.SubElement(xml_parent,
@@ -2302,13 +2316,15 @@ def logparser(registry, xml_parent, data):
2302 2316
 
2303 2317
     Minimal Example:
2304 2318
 
2305
-    .. literalinclude:: /../../tests/publishers/fixtures/logparser-minimal.yaml
2306
-       :language: yaml
2319
+        .. literalinclude::
2320
+           /../../tests/publishers/fixtures/logparser-minimal.yaml
2321
+           :language: yaml
2307 2322
 
2308 2323
     Full Example:
2309 2324
 
2310
-    .. literalinclude:: /../../tests/publishers/fixtures/logparser-full.yaml
2311
-       :language: yaml
2325
+        .. literalinclude::
2326
+           /../../tests/publishers/fixtures/logparser-full.yaml
2327
+           :language: yaml
2312 2328
     """
2313 2329
 
2314 2330
     clog = XML.SubElement(xml_parent,
@@ -2370,8 +2386,8 @@ def jira(registry, xml_parent, data):
2370 2386
 
2371 2387
     Example:
2372 2388
 
2373
-    .. literalinclude:: /../../tests/publishers/fixtures/jira001.yaml
2374
-       :language: yaml
2389
+        .. literalinclude:: /../../tests/publishers/fixtures/jira001.yaml
2390
+           :language: yaml
2375 2391
     """
2376 2392
     XML.SubElement(xml_parent, 'hudson.plugins.jira.JiraIssueUpdater')
2377 2393
 
@@ -2387,13 +2403,13 @@ def growl(registry, xml_parent, data):
2387 2403
 
2388 2404
     Minimal Example:
2389 2405
 
2390
-    .. literalinclude:: /../../tests/publishers/fixtures/growl-minimal.yaml
2391
-       :language: yaml
2406
+        .. literalinclude:: /../../tests/publishers/fixtures/growl-minimal.yaml
2407
+           :language: yaml
2392 2408
 
2393 2409
     Full Example:
2394 2410
 
2395
-    .. literalinclude:: /../../tests/publishers/fixtures/growl-full.yaml
2396
-       :language: yaml
2411
+        .. literalinclude:: /../../tests/publishers/fixtures/growl-full.yaml
2412
+           :language: yaml
2397 2413
     """
2398 2414
     growl = XML.SubElement(xml_parent, 'hudson.plugins.growl.GrowlPublisher')
2399 2415
     growl.set('plugin', 'growl')
@@ -2429,9 +2445,9 @@ def groovy_postbuild(registry, xml_parent, data):
2429 2445
 
2430 2446
     Example:
2431 2447
 
2432
-    .. literalinclude::
2433
-        /../../tests/publishers/fixtures/groovy-postbuild001.yaml
2434
-       :language: yaml
2448
+        .. literalinclude::
2449
+            /../../tests/publishers/fixtures/groovy-postbuild001.yaml
2450
+           :language: yaml
2435 2451
     """
2436 2452
     logger = logging.getLogger("%s:groovy-postbuild" % __name__)
2437 2453
     # Backward compatibility with old format
@@ -2571,8 +2587,8 @@ def cifs(registry, xml_parent, data):
2571 2587
 
2572 2588
     Example:
2573 2589
 
2574
-    .. literalinclude::  /../../tests/publishers/fixtures/cifs001.yaml
2575
-       :language: yaml
2590
+        .. literalinclude::  /../../tests/publishers/fixtures/cifs001.yaml
2591
+           :language: yaml
2576 2592
 
2577 2593
     """
2578 2594
     console_prefix = 'CIFS: '
@@ -2599,8 +2615,8 @@ def cigame(registry, xml_parent, data):
2599 2615
 
2600 2616
     Example:
2601 2617
 
2602
-    .. literalinclude:: /../../tests/publishers/fixtures/cigame.yaml
2603
-       :language: yaml
2618
+        .. literalinclude:: /../../tests/publishers/fixtures/cigame.yaml
2619
+           :language: yaml
2604 2620
     """
2605 2621
     XML.SubElement(xml_parent, 'hudson.plugins.cigame.GamePublisher')
2606 2622
 
@@ -2644,12 +2660,13 @@ def sonar(registry, xml_parent, data):
2644 2660
 
2645 2661
     Minimal Example:
2646 2662
 
2647
-    .. literalinclude:: /../../tests/publishers/fixtures/sonar-minimal.yaml
2648
-       :language: yaml
2663
+        .. literalinclude:: /../../tests/publishers/fixtures/sonar-minimal.yaml
2664
+           :language: yaml
2649 2665
 
2650 2666
     Full Example:
2651
-    .. literalinclude:: /../../tests/publishers/fixtures/sonar-full.yaml
2652
-       :language: yaml
2667
+
2668
+        .. literalinclude:: /../../tests/publishers/fixtures/sonar-full.yaml
2669
+           :language: yaml
2653 2670
     """
2654 2671
 
2655 2672
     sonar = XML.SubElement(xml_parent, 'hudson.plugins.sonar.SonarPublisher')
@@ -2730,15 +2747,15 @@ def performance(registry, xml_parent, data):
2730 2747
 
2731 2748
     Minimal Example:
2732 2749
 
2733
-    .. literalinclude::
2734
-       /../../tests/publishers/fixtures/performance-minimal.yaml
2735
-       :language: yaml
2750
+        .. literalinclude::
2751
+           /../../tests/publishers/fixtures/performance-minimal.yaml
2752
+           :language: yaml
2736 2753
 
2737 2754
     Full Example:
2738 2755
 
2739
-    .. literalinclude::
2740
-       /../../tests/publishers/fixtures/performance-full.yaml
2741
-       :language: yaml
2756
+        .. literalinclude::
2757
+           /../../tests/publishers/fixtures/performance-full.yaml
2758
+           :language: yaml
2742 2759
     """
2743 2760
     perf = XML.SubElement(xml_parent, 'hudson.plugins.performance.'
2744 2761
                                       'PerformancePublisher')
@@ -2825,8 +2842,9 @@ def join_trigger(registry, xml_parent, data):
2825 2842
 
2826 2843
     Example:
2827 2844
 
2828
-    .. literalinclude:: /../../tests/publishers/fixtures/join-trigger001.yaml
2829
-       :language: yaml
2845
+        .. literalinclude::
2846
+           /../../tests/publishers/fixtures/join-trigger001.yaml
2847
+           :language: yaml
2830 2848
     """
2831 2849
     jointrigger = XML.SubElement(xml_parent, 'join.JoinTrigger')
2832 2850
 
@@ -2879,13 +2897,14 @@ def jabber(registry, xml_parent, data):
2879 2897
 
2880 2898
     Minimal Example:
2881 2899
 
2882
-    .. literalinclude:: /../../tests/publishers/fixtures/jabber-minimal.yaml
2883
-       :language: yaml
2900
+        .. literalinclude::
2901
+           /../../tests/publishers/fixtures/jabber-minimal.yaml
2902
+           :language: yaml
2884 2903
 
2885 2904
     Full Example:
2886 2905
 
2887
-    .. literalinclude:: /../../tests/publishers/fixtures/jabber-full.yaml
2888
-       :language: yaml
2906
+        .. literalinclude:: /../../tests/publishers/fixtures/jabber-full.yaml
2907
+           :language: yaml
2889 2908
     """
2890 2909
     j = XML.SubElement(xml_parent, 'hudson.plugins.jabber.im.transport.'
2891 2910
                        'JabberPublisher')
@@ -6662,15 +6681,15 @@ def jms_messaging(registry, xml_parent, data):
6662 6681
 
6663 6682
     Full Example:
6664 6683
 
6665
-    .. literalinclude::
6666
-        ../../tests/publishers/fixtures/jms-messaging-full.yaml
6667
-       :language: yaml
6684
+        .. literalinclude::
6685
+            ../../tests/publishers/fixtures/jms-messaging-full.yaml
6686
+           :language: yaml
6668 6687
 
6669 6688
     Minimal Example:
6670 6689
 
6671
-    .. literalinclude::
6672
-        ../../tests/publishers/fixtures/jms-messaging-minimal.yaml
6673
-       :language: yaml
6690
+        .. literalinclude::
6691
+            ../../tests/publishers/fixtures/jms-messaging-minimal.yaml
6692
+           :language: yaml
6674 6693
     """
6675 6694
     helpers.jms_messaging_common(xml_parent, 'com.redhat.jenkins.plugins.ci.'
6676 6695
                                              'CIMessageNotifier', data)
@@ -6702,15 +6721,15 @@ def openshift_build_canceller(registry, xml_parent, data):
6702 6721
 
6703 6722
     Full Example:
6704 6723
 
6705
-    .. literalinclude::
6706
-        ../../tests/publishers/fixtures/openshift-build-canceller001.yaml
6707
-       :language: yaml
6724
+        .. literalinclude::
6725
+            ../../tests/publishers/fixtures/openshift-build-canceller001.yaml
6726
+           :language: yaml
6708 6727
 
6709 6728
     Minimal Example:
6710 6729
 
6711
-    .. literalinclude::
6712
-        ../../tests/publishers/fixtures/openshift-build-canceller002.yaml
6713
-       :language: yaml
6730
+        .. literalinclude::
6731
+            ../../tests/publishers/fixtures/openshift-build-canceller002.yaml
6732
+           :language: yaml
6714 6733
     """
6715 6734
 
6716 6735
     osb = XML.SubElement(xml_parent,
@@ -6750,15 +6769,15 @@ def openshift_deploy_canceller(registry, xml_parent, data):
6750 6769
 
6751 6770
     Full Example:
6752 6771
 
6753
-    .. literalinclude::
6754
-        ../../tests/publishers/fixtures/openshift-deploy-canceller001.yaml
6755
-       :language: yaml
6772
+        .. literalinclude::
6773
+            ../../tests/publishers/fixtures/openshift-deploy-canceller001.yaml
6774
+           :language: yaml
6756 6775
 
6757 6776
     Minimal Example:
6758 6777
 
6759
-    .. literalinclude::
6760
-        ../../tests/publishers/fixtures/openshift-deploy-canceller002.yaml
6761
-       :language: yaml
6778
+        .. literalinclude::
6779
+            ../../tests/publishers/fixtures/openshift-deploy-canceller002.yaml
6780
+           :language: yaml
6762 6781
     """
6763 6782
 
6764 6783
     osb = XML.SubElement(xml_parent,
@@ -6796,15 +6815,15 @@ def github_pull_request_merge(registry, xml_parent, data):
6796 6815
 
6797 6816
     Full Example:
6798 6817
 
6799
-    .. literalinclude::
6800
-        ../../tests/publishers/fixtures/github-pull-request-merge001.yaml
6801
-       :language: yaml
6818
+        .. literalinclude::
6819
+            ../../tests/publishers/fixtures/github-pull-request-merge001.yaml
6820
+           :language: yaml
6802 6821
 
6803 6822
     Minimal Example:
6804 6823
 
6805
-    .. literalinclude::
6806
-        ../../tests/publishers/fixtures/github-pull-request-merge002.yaml
6807
-       :language: yaml
6824
+        .. literalinclude::
6825
+            ../../tests/publishers/fixtures/github-pull-request-merge002.yaml
6826
+           :language: yaml
6808 6827
     """
6809 6828
 
6810 6829
     osb = XML.SubElement(xml_parent,
@@ -6830,8 +6849,8 @@ def chuck_norris(registry, xml_parent, data):
6830 6849
 
6831 6850
     Example:
6832 6851
 
6833
-    .. literalinclude:: /../../tests/publishers/fixtures/chuck-norris.yaml
6834
-       :language: yaml
6852
+        .. literalinclude:: /../../tests/publishers/fixtures/chuck-norris.yaml
6853
+           :language: yaml
6835 6854
     """
6836 6855
 
6837 6856
     chuck = XML.SubElement(xml_parent,

+ 2
- 0
jenkins_jobs/modules/scm.py View File

@@ -793,8 +793,10 @@ def svn(registry, xml_parent, data):
793 793
     :arg list repos: list of repositories to checkout (optional)
794 794
     :arg list additional-credentials: list of additional credentials (optional)
795 795
         :Additional-Credentials:
796
+
796 797
             * **realm** (`str`) --  realm to use
797 798
             * **credentials-id** (`str`) -- optional ID of credentials to use
799
+
798 800
     :arg str viewvc-url: URL of the svn web interface (optional)
799 801
 
800 802
         :Repo:

+ 1
- 1
jenkins_jobs/modules/triggers.py View File

@@ -1928,7 +1928,7 @@ def stash_pull_request(registry, xml_parent, data):
1928 1928
     """yaml: stash-pull-request
1929 1929
     Trigger builds via Stash/Bitbucket Server Pull Requests.
1930 1930
     Requires the Jenkins :jenkins-wiki:`Stash Pull Request Builder Plugin
1931
-      <Stash+pullrequest+builder+plugin>`.
1931
+    <Stash+pullrequest+builder+plugin>`.
1932 1932
 
1933 1933
       :arg str cron: cron syntax of when to run (required)
1934 1934
       :arg str stash-host: The HTTP or HTTPS URL of the Stash host (NOT ssh).

+ 1
- 1
jenkins_jobs/modules/view_list.py View File

@@ -16,7 +16,7 @@
16 16
 The view list module handles creating Jenkins List views.
17 17
 
18 18
 To create a list view specify ``list`` in the ``view-type`` attribute
19
-to the :ref:`View-list` definition.
19
+to the :ref:`view_list` definition.
20 20
 
21 21
 :View Parameters:
22 22
     * **name** (`str`): The name of the view.

+ 1
- 1
jenkins_jobs/modules/view_pipeline.py View File

@@ -15,7 +15,7 @@
15 15
 """
16 16
 The view pipeline module handles creating Jenkins Build Pipeline views.
17 17
 To create a list view specify ``list`` in the ``view-type`` attribute
18
-to the :ref:`View-pipeline` definition.
18
+to the :ref:`view_pipeline` definition.
19 19
 Requires the Jenkins
20 20
 :jenkins-wiki:`Build Pipeline Plugin <build+pipeline+plugin>`.
21 21
 

+ 1
- 0
setup.cfg View File

@@ -2,6 +2,7 @@
2 2
 all_files = 1
3 3
 build-dir = doc/build
4 4
 source-dir = doc/source
5
+warning-is-error = 1
5 6
 
6 7
 [metadata]
7 8
 name = jenkins-job-builder

+ 1
- 1
test-requirements.txt View File

@@ -6,7 +6,7 @@ hacking<0.13,>=0.12.0 # Apache-2.0
6 6
 coverage>=4.0 # Apache-2.0
7 7
 fixtures>=3.0.0 # Apache-2.0/BSD
8 8
 python-subunit>=0.0.18 # Apache-2.0/BSD
9
-sphinx>=1.3.1,<1.5.0
9
+sphinx>=1.5.0,<1.7.0
10 10
 testscenarios>=0.4 # Apache-2.0/BSD
11 11
 testtools>=1.4.0 # MIT
12 12
 testrepository>=0.0.18 # Apache-2.0/BSD

+ 1
- 1
tests/base.py View File

@@ -52,7 +52,7 @@ from jenkins_jobs.xml_config import XmlJobGenerator
52 52
 # This dance deals with the fact that we want unittest.mock if
53 53
 # we're on Python 3.4 and later, and non-stdlib mock otherwise.
54 54
 try:
55
-    from unittest import mock
55
+    from unittest import mock  # noqa
56 56
 except ImportError:
57 57
     import mock  # noqa
58 58
 

Loading…
Cancel
Save