From 32bb58955e3dedd47b7a349f0161d05d079f48c4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 22 Jun 2024 06:09:26 +0200 Subject: [PATCH] chore(python-docs): update python doc assets to recent development state (#184) --- .../dev/getting-started/developing/index.html | 19 +++- .../getting-started/first-steps/index.html | 17 +++- .../dev/getting-started/quickstart/index.html | 11 ++ docs-python/dev/index.html | 11 ++ .../dev/reference/client/client/index.html | 13 ++- .../dev/reference/client/config/index.html | 11 ++ .../client/credential_provider/index.html | 13 ++- .../endpoint/api/data_lake_measure/index.html | 21 +++- .../endpoint/api/data_stream/index.html | 13 ++- .../reference/endpoint/api/version/index.html | 15 ++- .../reference/endpoint/endpoint/index.html | 17 +++- .../reference/endpoint/exceptions/index.html | 13 ++- .../function_zoo/river_function/index.html | 15 ++- .../functions/broker/broker/index.html | 11 ++ .../broker/broker_handler/index.html | 11 ++ .../functions/broker/consumer/index.html | 11 ++ .../broker/kafka/kafka_consumer/index.html | 11 ++ .../kafka/kafka_message_fetcher/index.html | 11 ++ .../broker/kafka/kafka_publisher/index.html | 11 ++ .../broker/nats/nats_consumer/index.html | 11 ++ .../broker/nats/nats_publisher/index.html | 11 ++ .../broker/output_collector/index.html | 11 ++ .../functions/broker/publisher/index.html | 11 ++ .../functions/function_handler/index.html | 11 ++ .../functions/registration/index.html | 11 ++ .../functions/streampipes_function/index.html | 23 +++-- .../utils/async_iter_handler/index.html | 11 ++ .../utils/data_stream_context/index.html | 11 ++ .../utils/data_stream_generator/index.html | 11 ++ .../utils/function_context/index.html | 11 ++ .../dev/reference/model/common/index.html | 33 ++++-- .../container/data_lake_measures/index.html | 13 ++- .../model/container/data_streams/index.html | 13 ++- .../container/resource_container/index.html | 13 ++- .../model/container/versions/index.html | 13 ++- .../resource/data_lake_measure/index.html | 11 ++ .../model/resource/data_series/index.html | 11 ++ .../model/resource/data_stream/index.html | 11 ++ .../model/resource/exceptions/index.html | 11 ++ .../resource/function_definition/index.html | 11 ++ .../model/resource/query_result/index.html | 11 ++ .../model/resource/resource/index.html | 11 ++ .../model/resource/version/index.html | 11 ++ docs-python/dev/search/search_index.json | 2 +- docs-python/dev/sitemap.xml | 96 +++++++++--------- docs-python/dev/sitemap.xml.gz | Bin 712 -> 712 bytes .../index.html | 19 +++- .../index.html | 23 +++-- .../index.html | 11 ++ .../index.html | 11 ++ .../index.html | 13 ++- 51 files changed, 632 insertions(+), 104 deletions(-) diff --git a/docs-python/dev/getting-started/developing/index.html b/docs-python/dev/getting-started/developing/index.html index cfc3ad419..d70f65078 100644 --- a/docs-python/dev/getting-started/developing/index.html +++ b/docs-python/dev/getting-started/developing/index.html @@ -2366,7 +2366,7 @@
1) Set up your Python environment
-Create a virtual Python environment using a tool of your choice. +
Create a virtual Python environment using a tool of your choice. To manage dependencies, we use Poetry, so please install poetry in your local environment, e.g. via
pip install poetry
The pre-commit hook is run before every commit and takes care about code style, linting, type hints, import sorting, etc. It will stop your commit in case the changes do not apply the expected format. -Always check to have the recent version of the pre-commit hook installed otherwise the CI build might fail. +Always check to have the recent version of the pre-commit hook installed otherwise the CI build might fail. If you are interested, you can have a deeper look on the underlying library: pre-commit.
pre-commit install