From 113f580fdb5c60a5c6e6c41cfd2d5c537ba662ae Mon Sep 17 00:00:00 2001 From: lukasmittag Date: Fri, 19 Jul 2024 11:57:08 +0000 Subject: [PATCH] Update docs again? --- docs/index.md | 5 +++++ docs/velocitas_lib.conan_utils.md | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 0d0a053..9b91dd8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,6 +6,7 @@ - [`velocitas_lib`](./velocitas_lib.md#module-velocitas_lib) - [`velocitas_lib.conan_utils`](./velocitas_lib.conan_utils.md#module-velocitas_libconan_utils) +- [`velocitas_lib.docker`](./velocitas_lib.docker.md#module-velocitas_libdocker) - [`velocitas_lib.functional_interface`](./velocitas_lib.functional_interface.md#module-velocitas_libfunctional_interface) - [`velocitas_lib.middleware`](./velocitas_lib.middleware.md#module-velocitas_libmiddleware) - [`velocitas_lib.services`](./velocitas_lib.services.md#module-velocitas_libservices) @@ -42,6 +43,10 @@ - [`conan_utils.add_dependency_to_conanfile`](./velocitas_lib.conan_utils.md#function-add_dependency_to_conanfile): Add the dependency name to the project's list of dependencies. - [`conan_utils.export_conan_project`](./velocitas_lib.conan_utils.md#function-export_conan_project): Export a conan project to the local conan cache. - [`conan_utils.get_required_sdk_version`](./velocitas_lib.conan_utils.md#function-get_required_sdk_version): Return the required version of the core SDK. +- [`docker.build_vehicleapp_image`](./velocitas_lib.docker.md#function-build_vehicleapp_image): Build VehicleApp docker image and display the progress using a spinner. +- [`docker.container_exists`](./velocitas_lib.docker.md#function-container_exists): Check if a container with a given name exists. +- [`docker.is_docker_image_build_locally`](./velocitas_lib.docker.md#function-is_docker_image_build_locally): Check if vehicle app docker image is locally available +- [`docker.push_docker_image_to_registry`](./velocitas_lib.docker.md#function-push_docker_image_to_registry): Push docker image to local image registry - [`functional_interface.get_interfaces_for_type`](./velocitas_lib.functional_interface.md#function-get_interfaces_for_type): Return all interfaces for the given type. - [`middleware.get_middleware_type`](./velocitas_lib.middleware.md#function-get_middleware_type): Return the current middleware type. - [`services.get_service_port`](./velocitas_lib.services.md#function-get_service_port): Return the service port as string for the specified service. diff --git a/docs/velocitas_lib.conan_utils.md b/docs/velocitas_lib.conan_utils.md index 069b2ed..2bb28e2 100644 --- a/docs/velocitas_lib.conan_utils.md +++ b/docs/velocitas_lib.conan_utils.md @@ -15,7 +15,7 @@ ## function `get_required_sdk_version` ```python -get_required_sdk_version() → Union[str, NoneType] +get_required_sdk_version() → Optional[str] ``` Return the required version of the core SDK.