Skip to content

Commit b9b3a3d

Browse files
thaJeztahndeloof
authored andcommitted
docs: update cli-docs-tool to v0.4.0
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 1d06741 commit b9b3a3d

25 files changed

+130
-3
lines changed

docs/reference/docker_compose.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ options:
163163
description: |
164164
Control when to print ANSI control characters ("never"|"always"|"auto")
165165
deprecated: false
166+
hidden: false
166167
experimental: false
167168
experimentalcli: false
168169
kubernetes: false
@@ -172,6 +173,7 @@ options:
172173
default_value: "false"
173174
description: Run compose in backward compatibility mode
174175
deprecated: false
176+
hidden: false
175177
experimental: false
176178
experimentalcli: false
177179
kubernetes: false
@@ -180,6 +182,7 @@ options:
180182
value_type: string
181183
description: Specify an alternate environment file.
182184
deprecated: false
185+
hidden: false
183186
experimental: false
184187
experimentalcli: false
185188
kubernetes: false
@@ -190,6 +193,7 @@ options:
190193
default_value: '[]'
191194
description: Compose configuration files
192195
deprecated: false
196+
hidden: false
193197
experimental: false
194198
experimentalcli: false
195199
kubernetes: false
@@ -199,6 +203,7 @@ options:
199203
default_value: "false"
200204
description: Do not print ANSI control characters (DEPRECATED)
201205
deprecated: false
206+
hidden: true
202207
experimental: false
203208
experimentalcli: false
204209
kubernetes: false
@@ -208,6 +213,7 @@ options:
208213
default_value: '[]'
209214
description: Specify a profile to enable
210215
deprecated: false
216+
hidden: false
211217
experimental: false
212218
experimentalcli: false
213219
kubernetes: false
@@ -218,6 +224,7 @@ options:
218224
Specify an alternate working directory
219225
(default: the path of the Compose file)
220226
deprecated: false
227+
hidden: false
221228
experimental: false
222229
experimentalcli: false
223230
kubernetes: false
@@ -227,6 +234,7 @@ options:
227234
value_type: string
228235
description: Project name
229236
deprecated: false
237+
hidden: false
230238
experimental: false
231239
experimentalcli: false
232240
kubernetes: false
@@ -236,6 +244,7 @@ options:
236244
default_value: "false"
237245
description: Show more output
238246
deprecated: false
247+
hidden: true
239248
experimental: false
240249
experimentalcli: false
241250
kubernetes: false
@@ -246,6 +255,7 @@ options:
246255
default_value: "false"
247256
description: Show the Docker Compose version information
248257
deprecated: false
258+
hidden: true
249259
experimental: false
250260
experimentalcli: false
251261
kubernetes: false
@@ -257,6 +267,7 @@ options:
257267
Specify an alternate working directory
258268
(default: the path of the Compose file)
259269
deprecated: false
270+
hidden: true
260271
experimental: false
261272
experimentalcli: false
262273
kubernetes: false

docs/reference/docker_compose_build.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ options:
1919
default_value: '[]'
2020
description: Set build-time variables for services.
2121
deprecated: false
22+
hidden: false
2223
experimental: false
2324
experimentalcli: false
2425
kubernetes: false
@@ -28,6 +29,7 @@ options:
2829
default_value: "true"
2930
description: Compress the build context using gzip. DEPRECATED
3031
deprecated: false
32+
hidden: true
3133
experimental: false
3234
experimentalcli: false
3335
kubernetes: false
@@ -37,6 +39,7 @@ options:
3739
default_value: "true"
3840
description: Always remove intermediate containers. DEPRECATED
3941
deprecated: false
42+
hidden: true
4043
experimental: false
4144
experimentalcli: false
4245
kubernetes: false
@@ -47,6 +50,7 @@ options:
4750
description: |
4851
Set memory limit for the build container. Not supported on buildkit yet.
4952
deprecated: false
53+
hidden: true
5054
experimental: false
5155
experimentalcli: false
5256
kubernetes: false
@@ -56,6 +60,7 @@ options:
5660
default_value: "false"
5761
description: Do not use cache when building the image
5862
deprecated: false
63+
hidden: false
5964
experimental: false
6065
experimentalcli: false
6166
kubernetes: false
@@ -66,6 +71,7 @@ options:
6671
description: |
6772
Do not remove intermediate containers after a successful build. DEPRECATED
6873
deprecated: false
74+
hidden: true
6975
experimental: false
7076
experimentalcli: false
7177
kubernetes: false
@@ -75,6 +81,7 @@ options:
7581
default_value: "true"
7682
description: Build images in parallel. DEPRECATED
7783
deprecated: false
84+
hidden: true
7885
experimental: false
7986
experimentalcli: false
8087
kubernetes: false
@@ -84,6 +91,7 @@ options:
8491
default_value: auto
8592
description: Set type of progress output (auto, tty, plain, quiet)
8693
deprecated: false
94+
hidden: false
8795
experimental: false
8896
experimentalcli: false
8997
kubernetes: false
@@ -93,6 +101,7 @@ options:
93101
default_value: "false"
94102
description: Always attempt to pull a newer version of the image.
95103
deprecated: false
104+
hidden: false
96105
experimental: false
97106
experimentalcli: false
98107
kubernetes: false
@@ -103,6 +112,7 @@ options:
103112
default_value: "false"
104113
description: Don't print anything to STDOUT
105114
deprecated: false
115+
hidden: false
106116
experimental: false
107117
experimentalcli: false
108118
kubernetes: false

docs/reference/docker_compose_convert.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ options:
1616
default_value: yaml
1717
description: 'Format the output. Values: [yaml | json]'
1818
deprecated: false
19+
hidden: false
1920
experimental: false
2021
experimentalcli: false
2122
kubernetes: false
@@ -24,6 +25,7 @@ options:
2425
value_type: string
2526
description: Print the service config hash, one per line.
2627
deprecated: false
28+
hidden: false
2729
experimental: false
2830
experimentalcli: false
2931
kubernetes: false
@@ -33,6 +35,7 @@ options:
3335
default_value: "false"
3436
description: Print the image names, one per line.
3537
deprecated: false
38+
hidden: false
3639
experimental: false
3740
experimentalcli: false
3841
kubernetes: false
@@ -42,6 +45,7 @@ options:
4245
default_value: "false"
4346
description: Don't interpolate environment variables.
4447
deprecated: false
48+
hidden: false
4549
experimental: false
4650
experimentalcli: false
4751
kubernetes: false
@@ -51,6 +55,7 @@ options:
5155
default_value: "false"
5256
description: Don't normalize compose model.
5357
deprecated: false
58+
hidden: false
5459
experimental: false
5560
experimentalcli: false
5661
kubernetes: false
@@ -60,6 +65,7 @@ options:
6065
value_type: string
6166
description: Save to file (default to stdout)
6267
deprecated: false
68+
hidden: false
6369
experimental: false
6470
experimentalcli: false
6571
kubernetes: false
@@ -69,6 +75,7 @@ options:
6975
default_value: "false"
7076
description: Print the profile names, one per line.
7177
deprecated: false
78+
hidden: false
7279
experimental: false
7380
experimentalcli: false
7481
kubernetes: false
@@ -79,6 +86,7 @@ options:
7986
default_value: "false"
8087
description: Only validate the configuration, don't print anything.
8188
deprecated: false
89+
hidden: false
8290
experimental: false
8391
experimentalcli: false
8492
kubernetes: false
@@ -88,6 +96,7 @@ options:
8896
default_value: "false"
8997
description: Pin image tags to digests.
9098
deprecated: false
99+
hidden: false
91100
experimental: false
92101
experimentalcli: false
93102
kubernetes: false
@@ -97,6 +106,7 @@ options:
97106
default_value: "false"
98107
description: Print the service names, one per line.
99108
deprecated: false
109+
hidden: false
100110
experimental: false
101111
experimentalcli: false
102112
kubernetes: false
@@ -106,6 +116,7 @@ options:
106116
default_value: "false"
107117
description: Print the volume names, one per line.
108118
deprecated: false
119+
hidden: false
109120
experimental: false
110121
experimentalcli: false
111122
kubernetes: false

docs/reference/docker_compose_cp.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ options:
1111
default_value: "false"
1212
description: Copy to all the containers of the service.
1313
deprecated: false
14+
hidden: false
1415
experimental: false
1516
experimentalcli: false
1617
kubernetes: false
@@ -21,6 +22,7 @@ options:
2122
default_value: "false"
2223
description: Archive mode (copy all uid/gid information)
2324
deprecated: false
25+
hidden: false
2426
experimental: false
2527
experimentalcli: false
2628
kubernetes: false
@@ -31,6 +33,7 @@ options:
3133
default_value: "false"
3234
description: Always follow symbol link in SRC_PATH
3335
deprecated: false
36+
hidden: false
3437
experimental: false
3538
experimentalcli: false
3639
kubernetes: false
@@ -41,6 +44,7 @@ options:
4144
description: |
4245
Index of the container if there are multiple instances of a service [default: 1].
4346
deprecated: false
47+
hidden: false
4448
experimental: false
4549
experimentalcli: false
4650
kubernetes: false

docs/reference/docker_compose_create.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ options:
1010
default_value: "false"
1111
description: Build images before starting containers.
1212
deprecated: false
13+
hidden: false
1314
experimental: false
1415
experimentalcli: false
1516
kubernetes: false
@@ -20,6 +21,7 @@ options:
2021
description: |
2122
Recreate containers even if their configuration and image haven't changed.
2223
deprecated: false
24+
hidden: false
2325
experimental: false
2426
experimentalcli: false
2527
kubernetes: false
@@ -29,6 +31,7 @@ options:
2931
default_value: "false"
3032
description: Don't build an image, even if it's missing.
3133
deprecated: false
34+
hidden: false
3235
experimental: false
3336
experimentalcli: false
3437
kubernetes: false
@@ -39,6 +42,7 @@ options:
3942
description: |
4043
If containers already exist, don't recreate them. Incompatible with --force-recreate.
4144
deprecated: false
45+
hidden: false
4246
experimental: false
4347
experimentalcli: false
4448
kubernetes: false

docs/reference/docker_compose_down.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ options:
2323
default_value: "false"
2424
description: Remove containers for services not defined in the Compose file.
2525
deprecated: false
26+
hidden: false
2627
experimental: false
2728
experimentalcli: false
2829
kubernetes: false
@@ -32,6 +33,7 @@ options:
3233
description: |
3334
Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all")
3435
deprecated: false
36+
hidden: false
3537
experimental: false
3638
experimentalcli: false
3739
kubernetes: false
@@ -42,6 +44,7 @@ options:
4244
default_value: "10"
4345
description: Specify a shutdown timeout in seconds
4446
deprecated: false
47+
hidden: false
4548
experimental: false
4649
experimentalcli: false
4750
kubernetes: false
@@ -53,6 +56,7 @@ options:
5356
description: |
5457
Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers.
5558
deprecated: false
59+
hidden: false
5660
experimental: false
5761
experimentalcli: false
5862
kubernetes: false

docs/reference/docker_compose_events.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ options:
2929
default_value: "false"
3030
description: Output events as a stream of json objects
3131
deprecated: false
32+
hidden: false
3233
experimental: false
3334
experimentalcli: false
3435
kubernetes: false

0 commit comments

Comments
 (0)