compose/docs/reference/docker_compose_stop.yaml

command: docker compose stop
short: Stop services
long: |
    Stops running containers without removing them. They can be started again with `docker compose start`.
usage: docker compose stop [OPTIONS] [SERVICE...]
pname: docker compose
plink: docker_compose.yaml
options:
    - option: timeout
      shorthand: t
      value_type: int
      default_value: "10"
      description: Specify a shutdown timeout in seconds
      deprecated: false
      hidden: false
      experimental: false
      experimentalcli: false
      kubernetes: false
      swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
generate reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-08 15:47:24 +01:00			`command: docker compose stop`
			`short: Stop services`
[v2] use "docker/cli-docs-tool" to generate docs Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2021-09-13 17:41:21 +02:00			`long: \|`
update cli-doc-tool and update the doc with this new version Signed-off-by: Guillaume Lours <guillaume.lours@docker.com> 2022-07-26 14:58:08 +02:00			Stops running containers without removing them. They can be started again with `docker compose start`.
update usage strings for consistency This updates the format of various usage strings to be more consistent with other parts of the CLI. - Use `[OPTIONS]` to indicate where command-specific options should be added - Use `[SERVICE...]` to indicate zero-or-more services - Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that option is part of the already mentioned `[OPTIONS]` and we don't provide usage for each possible option that can be passed. - Remove `[--]`, which (I think) was needed for the Python implementation, but is a general feature to stop processing flag-options. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> 2022-08-02 13:11:57 +02:00			`usage: docker compose stop [OPTIONS] [SERVICE...]`
generate reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-08 15:47:24 +01:00			`pname: docker compose`
			`plink: docker_compose.yaml`
			`options:`
update cli-doc-tool and update the doc with this new version Signed-off-by: Guillaume Lours <guillaume.lours@docker.com> 2022-07-26 14:58:08 +02:00			`- option: timeout`
			`shorthand: t`
			`value_type: int`
			`default_value: "10"`
			`description: Specify a shutdown timeout in seconds`
			`deprecated: false`
			`hidden: false`
			`experimental: false`
			`experimentalcli: false`
			`kubernetes: false`
			`swarm: false`
generate reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-08 15:47:24 +01:00			`deprecated: false`
			`experimental: false`
			`experimentalcli: false`
			`kubernetes: false`
			`swarm: false`