add auto/light/dark mode for docs

[s-light]

just like the example in the documentation:
https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode

[s-light]

hmm.
the docs render check failed with

added code example for nodes.md
Traceback (most recent call last):
  File "docs/autogen.py", line 127, in <module>
    mkdoc_autogen()
  File "docs/autogen.py", line 123, in mkdoc_autogen
    add_all_code_examples(destination_path)
  File "/home/runner/work/python-on-whales/python-on-whales/docs/docs_utils.py", line 494, in add_all_code_examples
    add_code_example(destination, "pods.md", generate_code_demo_pods())
  File "/home/runner/work/python-on-whales/python-on-whales/docs/docs_utils.py", line 447, in generate_code_demo_pods
    pod = podman.pod.create("my-pod")
  File "/home/runner/work/python-on-whales/python-on-whales/python_on_whales/components/pod/cli_wrapper.py", line 457, in create
    return Pod(self.client_config, run(full_cmd), is_immutable_id=True)
  File "/home/runner/work/python-on-whales/python-on-whales/python_on_whales/utils.py", line 222, in run
    raise DockerException(
python_on_whales.exceptions.DockerException: The command executed was `/usr/bin/podman pod create --name my-pod`.
It returned with code 125
The content of stdout is 'initializing source docker://k8s.gcr.io/pause:3.5: Requesting bear token: invalid status code from registry 404 (Not Found)
'
The content of stderr is 'Error: repository name must have at least one component
'

that seems not like a bug i introduced with my pullrequest.. (at least to me)

[gabrieldemarmiesse]

I think it'd unrelated to your PR. Dark mode is appreciated! I'll take a look at it. Thanks!

[gabrieldemarmiesse]

@s-light sorry for the delay. I re-ran the job, and got the following error: ModuleNotFoundError: No module named 'griffe.collections'. I think this should be added to the list of dependencies for the docs. You can find the file here: https://github.com/gabrieldemarmiesse/python-on-whales/blob/master/docs/requirements.txt

[LewisGaul]

I'm hitting the docs job issue mentioned too, where a podman command is failing with exit code 125 and output:

$ /usr/bin/podman pod create --name my-pod
initializing source docker://k8s.gcr.io/pause:3.5: Requesting bear token: invalid status code from registry 404 (Not Found)
Error: repository name must have at least one component

This "pause" container image it's trying to pull is used as the pod's default infra container, and the reason the doc generation is trying to run this command is to generate docs with real output from commands. I'm not sure why this is an issue on the docs job and not the podman pod tests job... My guess is it would be fixed by running scripts/ci-podman-update.sh in the docs job, I'll try that out in a separate PR.

[gabrieldemarmiesse]

I generated the docs locally, it looks awesome! Many thanks!

[s-light]

thanks for merging!
do you have to create a release for the deployment to get triggered?

Deployments :
github-pages 2 months ago

[gabrieldemarmiesse]

The documentation is updated automatically at every release. I'll create one soon, you'll see the changes then. It's going to make the docs much easier to read :)

[gabrieldemarmiesse]

It's live!