File tree Expand file tree Collapse file tree 1 file changed +34
-0
lines changed Expand file tree Collapse file tree 1 file changed +34
-0
lines changed Original file line number Diff line number Diff line change @@ -67,6 +67,13 @@ vendor/bin/mftf run:failed
67
67
This command cleans up the previously generated tests; generates and runs the tests listed in ` dev/tests/acceptance/tests/_output/failed ` .
68
68
For more details about ` failed ` , refer to [ Reporting] [ ] .
69
69
70
+ ### Generate documentation for action groups
71
+ ``` bash
72
+ vendor/bin/mftf generate:docs
73
+ ```
74
+
75
+ This command generates documentation for action groups.
76
+
70
77
## Reference
71
78
72
79
### ` build:project `
@@ -220,6 +227,33 @@ vendor/bin/mftf generate:urn-catalog [--force] [<path to the directory with misc
220
227
vendor/bin/mftf generate:urn-catalog .idea/
221
228
```
222
229
230
+ ### ` generate:docs `
231
+
232
+ #### Description
233
+
234
+ Generates documentation that lists all action groups available in the codebase.
235
+ The default path is ` <projectRoot>/dev/tests/docs/documentation.md ` .
236
+
237
+ #### Usage
238
+
239
+ ``` bash
240
+ vendor/bin/mftf generate:docs [--clean] [--output= /path/to/alternate/dir]
241
+ ```
242
+
243
+ #### Options
244
+
245
+ | Option | Description |
246
+ | ------------- | --------------------------------------------------------------------- |
247
+ | ` -c, --clean ` | Overwrites previously existing documentation |
248
+ | ` -o, --output ` | Changes the default output directory to a user specified directory |
249
+
250
+ #### Example
251
+
252
+ ``` bash
253
+ vendor/bin/mftf generate:docs --clean
254
+ ```
255
+
256
+
223
257
### ` reset `
224
258
225
259
#### Description
You can’t perform that action at this time.
0 commit comments