Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation deployment doesn't work anymore #489

Merged
merged 3 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
mkdocstrings==0.20.0
mkdocstrings-python==1.0.0
mkdocstrings-python==1.3.0
mkdocs-autorefs==0.4.1
mkdocs-material==9.1.14
pymdown-extensions==10.0.1
Expand Down
8 changes: 4 additions & 4 deletions python_on_whales/components/compose/cli_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def build(
services: The services to build (as list of strings).
If `None` (default), all services are built.
An empty list means that nothing will be built.
build_arguments: Set build-time variables for services. For example
build_args: Set build-time variables for services. For example
`build_args={"PY_VERSION": "3.7.8", "UBUNTU_VERSION": "20.04"}`.
cache: Set to `False` if you don't want to use the cache to build your images
progress: Set type of progress output (auto, tty, plain, quiet) (default "auto")
Expand Down Expand Up @@ -96,7 +96,7 @@ def create(
build: bool = False,
force_recreate: bool = False,
no_build: bool = False,
no_recreate=False,
no_recreate: bool = False,
):
"""Creates containers for a service.

Expand Down Expand Up @@ -361,8 +361,8 @@ def ls(
"""Returns a list of docker compose projects

Parameters:
all_stopped: Results include all stopped compose projects.
project_filters: Filter results based on conditions provided.
all: Results include all stopped compose projects.
filters: Filter results based on conditions provided.

# Returns
A `List[python_on_whales.ComposeProject]`
Expand Down
2 changes: 1 addition & 1 deletion python_on_whales/components/container/cli_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -972,7 +972,7 @@ def inspect(self, x: Union[str, List[str]]) -> Union[Container, List[Container]]
"""Returns a container object from a name or ID.

Parameters:
reference: A container name or ID, or a list of container names
x: A container name or ID, or a list of container names
and/or IDs

Returns:
Expand Down
2 changes: 1 addition & 1 deletion python_on_whales/components/context/cli_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ def create(
"""Creates a new context

Parameters:
context: name of the context to create
context_name: name of the context to create
default_stack_orchestrator: Default orchestrator for stack operations to use with this context (swarm|kubernetes|all)
description: Description of the context
docker: Set the docker endpoint, you can use a dict of a class to
Expand Down
2 changes: 1 addition & 1 deletion python_on_whales/components/plugin/cli_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ def remove(
"""Removes one or more plugins

Parameters:
plugin: One or more plugins to remove.
x: One or more plugins to remove.
force: Force the removal of this plugin.
"""
full_cmd = self.docker_cmd + ["plugin", "remove"]
Expand Down
4 changes: 2 additions & 2 deletions python_on_whales/components/stack/cli_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ def deploy(
Parameters:
name: The name of the stack to deploy. Mandatory.
compose_files: One or more docker-compose files. If there are more than
one, they will be fused together.
orchestrator: The orchestrator to use, `"swarm" or "kubernetes" or "all".
one, they will be fused together.
orchestrator: The orchestrator to use, `"swarm" or "kubernetes" or "all".
prune: Prune services that are no longer referenced
resolve_image: Query the registry to resolve image digest
and supported platforms `"always"|"changed"|"never"` (default `"always"`).
Expand Down
4 changes: 3 additions & 1 deletion python_on_whales/components/swarm/cli_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ def init(
availability: Availability of the node ("active"|"pause"|"drain")
data_path_address: Address or interface to use for data path
traffic (format is `<ip|interface>`)
listen_address: address upon which the node listens for inbound
swarm manager traffic (format: `<ip|interface>[:port]`)
"""
full_cmd = self.docker_cmd + ["swarm", "init"]
full_cmd.add_simple_arg("--advertise-addr", advertise_address)
Expand Down Expand Up @@ -110,7 +112,7 @@ def join(
(`"active"`|`"pause"`|`"drain"`)
data_path_address: Address or interface to use for data
path traffic (format: <ip|interface>)
listen-address: Listen address (format: <ip|interface>[:port])
listen_address: Listen address (format: <ip|interface>[:port])
(default 0.0.0.0:2377)
token: Token for entry into the swarm, will determine if
the node enters the swarm as a manager or a worker.
Expand Down
2 changes: 1 addition & 1 deletion python_on_whales/docker_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class DockerClient(DockerCLICaller):
debug: Enable debug mode
host: Daemon socket(s) to connect to
log_level: Set the logging level ("debug"|"info"|"warn"|"error"|"fatal")
(default "info")
(default "info")
tls: Use TLS; implied by `tlsverify`
tlscacert: Trust certs signed only by this CA (default "~/.docker/ca.pem")
compose_files: Docker compose yaml file
Expand Down