1
+ ## [ profile] .description
2
+
3
+ Type: Optional[ str]
4
+
5
+ Description of the profile.
6
+
7
+ ## [ profile] .detached
8
+
9
+ Type: Optional[ bool]
10
+
11
+ The profile should be detached."
12
+ Detached means it is not inherited from the main profile.
13
+
14
+ ## [ profile] .enabled
15
+
16
+ Type: Union[ bool, Condition, None]
17
+
18
+ If enabled the profile is used. You can also use and ` if ` condition
19
+ to calculate the enabled state.
20
+
21
+ Examples:
22
+ ``` toml
23
+ # alway disabled
24
+ enabled = false
25
+ ```
26
+
27
+ ``` toml
28
+ # enabled if TEST_VAR is set
29
+ enabled = { if = ' environ.get("CI") == "true"' }
30
+ ```
31
+
32
+ ## [ profile] .precedence
33
+
34
+ Type: Optional[ int]
35
+
36
+ Precedence of the profile. Lower values are executed first. If not set the order is undefined.
37
+
1
38
## args
2
39
3
40
Type: Optional[ List[ str]]
@@ -319,6 +356,21 @@ as --doc. Example: --metadata Version:1.2
319
356
320
357
corresponds to the ` -M --metadata name:value * ` option of _ robot_
321
358
359
+ ## extra-parse-include
360
+
361
+ Type: Optional[ List[ Union[ str, StringExpression]]]
362
+
363
+ Appends entries to the --parseinclude option.
364
+
365
+ Parse only files matching ` pattern ` . It can be:
366
+ - a file name or pattern like ` example.robot ` or
367
+ ` *.robot ` to parse all files matching that name,
368
+ - a file path like ` path/to/example.robot ` , or
369
+ - a directory path like ` path/to/example ` to parse
370
+ all files in that directory, recursively.
371
+
372
+ corresponds to the ` -I --parseinclude pattern * ` option of _ robot_
373
+
322
374
## extra-parsers
323
375
324
376
Type: Optional[ Dict[ str, List[ Union[ str, StringExpression]]]]
@@ -633,9 +685,9 @@ powerful variable setting mechanism.
633
685
Examples:
634
686
635
687
```
636
- --variable str:Hello => ${str } = `Hello `
637
- -v hi:Hi_World -E space:_ => ${hi } = `Hi World `
638
- -v x: -v y:42 => ${x} = ``, ${y} = `42`
688
+ --variable name:Robot => ${name } = `Robot `
689
+ -v "hello:Hello world" => ${hello } = `Hello world `
690
+ -v x: -v y:42 => ${x} = ``, ${y} = `42`
639
691
```
640
692
641
693
corresponds to the ` -v --variable name:value * ` option of _ rebot_
@@ -914,6 +966,19 @@ is considered relative to that unless it is absolute.
914
966
915
967
corresponds to the ` -d --outputdir dir ` option of _ robot_
916
968
969
+ ## parse-include
970
+
971
+ Type: Optional[ List[ Union[ str, StringExpression]]]
972
+
973
+ Parse only files matching ` pattern ` . It can be:
974
+ - a file name or pattern like ` example.robot ` or
975
+ ` *.robot ` to parse all files matching that name,
976
+ - a file path like ` path/to/example.robot ` , or
977
+ - a directory path like ` path/to/example ` to parse
978
+ all files in that directory, recursively.
979
+
980
+ corresponds to the ` -I --parseinclude pattern * ` option of _ robot_
981
+
917
982
## parsers
918
983
919
984
Type: Optional[ Dict[ str, List[ Union[ str, StringExpression]]]]
@@ -1193,6 +1258,21 @@ as --doc. Example: --metadata Version:1.2
1193
1258
1194
1259
corresponds to the ` -M --metadata name:value * ` option of _ robot_
1195
1260
1261
+ ## rebot.extra-parse-include
1262
+
1263
+ Type: Optional[ List[ Union[ str, StringExpression]]]
1264
+
1265
+ Appends entries to the --parseinclude option.
1266
+
1267
+ Parse only files matching ` pattern ` . It can be:
1268
+ - a file name or pattern like ` example.robot ` or
1269
+ ` *.robot ` to parse all files matching that name,
1270
+ - a file path like ` path/to/example.robot ` , or
1271
+ - a directory path like ` path/to/example ` to parse
1272
+ all files in that directory, recursively.
1273
+
1274
+ corresponds to the ` -I --parseinclude pattern * ` option of _ robot_
1275
+
1196
1276
## rebot.extra-pre-rebot-modifiers
1197
1277
1198
1278
Type: Optional[ Dict[ str, List[ Union[ str, StringExpression]]]]
@@ -1553,6 +1633,19 @@ is considered relative to that unless it is absolute.
1553
1633
1554
1634
corresponds to the ` -d --outputdir dir ` option of _ robot_
1555
1635
1636
+ ## rebot.parse-include
1637
+
1638
+ Type: Optional[ List[ Union[ str, StringExpression]]]
1639
+
1640
+ Parse only files matching ` pattern ` . It can be:
1641
+ - a file name or pattern like ` example.robot ` or
1642
+ ` *.robot ` to parse all files matching that name,
1643
+ - a file path like ` path/to/example.robot ` , or
1644
+ - a directory path like ` path/to/example ` to parse
1645
+ all files in that directory, recursively.
1646
+
1647
+ corresponds to the ` -I --parseinclude pattern * ` option of _ robot_
1648
+
1556
1649
## rebot.pre-rebot-modifiers
1557
1650
1558
1651
Type: Optional[ Dict[ str, List[ Union[ str, StringExpression]]]]
@@ -2318,9 +2411,9 @@ powerful variable setting mechanism.
2318
2411
Examples:
2319
2412
2320
2413
```
2321
- --variable str:Hello => ${str } = `Hello `
2322
- -v hi:Hi_World -E space:_ => ${hi } = `Hi World `
2323
- -v x: -v y:42 => ${x} = ``, ${y} = `42`
2414
+ --variable name:Robot => ${name } = `Robot `
2415
+ -v "hello:Hello world" => ${hello } = `Hello world `
2416
+ -v x: -v y:42 => ${x} = ``, ${y} = `42`
2324
2417
```
2325
2418
2326
2419
corresponds to the ` -v --variable name:value * ` option of _ robot_
@@ -2333,5 +2426,3 @@ xUnit compatible result file. Not created unless this
2333
2426
option is specified.
2334
2427
2335
2428
corresponds to the ` -x --xunit file ` option of _ robot_
2336
-
2337
-
0 commit comments