add documentation for packages - 2023-12-12 (#908)

apache · Dec 17, 2023 · 85de119 · 85de119
1 parent 1ebafff
commit 85de119
Show file tree

Hide file tree

Showing 175 changed files with 83,073 additions and 762 deletions.
diff --git a/docs-archive/apache-airflow-providers-daskexecutor/1.1.1/security/security-model.html b/docs-archive/apache-airflow-providers-daskexecutor/1.1.1/security/security-model.html
@@ -0,0 +1 @@
+<html><head><meta http-equiv="refresh" content="0; url=../security.html"/></head></html>
diff --git a/docs-archive/apache-airflow-providers-docker/3.9.0/.buildinfo b/docs-archive/apache-airflow-providers-docker/3.9.0/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6a53893bdd2a1c627a99fcdfd209680c
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/...airflow-providers-docker/3.9.0/_api/airflow/providers/docker/decorators/docker/index.html b/...airflow-providers-docker/3.9.0/_api/airflow/providers/docker/decorators/docker/index.html
diff --git a/...apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/decorators/index.html b/...apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/decorators/index.html
diff --git a/...apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/exceptions/index.html b/...apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/exceptions/index.html
diff --git a/...ache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/hooks/docker/index.html b/...ache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/hooks/docker/index.html
diff --git a/...hive/apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/hooks/index.html b/...hive/apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/hooks/index.html
diff --git a/docs-archive/apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/index.html b/docs-archive/apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/index.html
diff --git a/...-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/operators/docker/index.html b/...-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/operators/docker/index.html
diff --git a/...ow-providers-docker/3.9.0/_api/airflow/providers/docker/operators/docker_swarm/index.html b/...ow-providers-docker/3.9.0/_api/airflow/providers/docker/operators/docker_swarm/index.html
diff --git a/.../apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/operators/index.html b/.../apache-airflow-providers-docker/3.9.0/_api/airflow/providers/docker/operators/index.html
diff --git a/...rflow-providers-docker/3.9.0/_api/tests/system/providers/docker/example_docker/index.html b/...rflow-providers-docker/3.9.0/_api/tests/system/providers/docker/example_docker/index.html
diff --git a/...iders-docker/3.9.0/_api/tests/system/providers/docker/example_docker_copy_data/index.html b/...iders-docker/3.9.0/_api/tests/system/providers/docker/example_docker_copy_data/index.html
diff --git a/...providers-docker/3.9.0/_api/tests/system/providers/docker/example_docker_swarm/index.html b/...providers-docker/3.9.0/_api/tests/system/providers/docker/example_docker_swarm/index.html
diff --git a/...chive/apache-airflow-providers-docker/3.9.0/_api/tests/system/providers/docker/index.html b/...chive/apache-airflow-providers-docker/3.9.0/_api/tests/system/providers/docker/index.html
diff --git a/docs-archive/apache-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker.html b/docs-archive/apache-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker.html
diff --git a/...e-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker/decorators/docker.html b/...e-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker/decorators/docker.html
diff --git a/...e/apache-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker/exceptions.html b/...e/apache-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker/exceptions.html
diff --git a/...apache-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker/hooks/docker.html b/...apache-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker/hooks/docker.html
diff --git a/...he-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker/operators/docker.html b/...he-airflow-providers-docker/3.9.0/_modules/airflow/providers/docker/operators/docker.html
diff --git a/...flow-providers-docker/3.9.0/_modules/airflow/providers/docker/operators/docker_swarm.html b/...flow-providers-docker/3.9.0/_modules/airflow/providers/docker/operators/docker_swarm.html
diff --git a/docs-archive/apache-airflow-providers-docker/3.9.0/_modules/index.html b/docs-archive/apache-airflow-providers-docker/3.9.0/_modules/index.html
diff --git a/...airflow-providers-docker/3.9.0/_modules/tests/system/providers/docker/example_docker.html b/...airflow-providers-docker/3.9.0/_modules/tests/system/providers/docker/example_docker.html
diff --git a/...oviders-docker/3.9.0/_modules/tests/system/providers/docker/example_docker_copy_data.html b/...oviders-docker/3.9.0/_modules/tests/system/providers/docker/example_docker_copy_data.html
diff --git a/...w-providers-docker/3.9.0/_modules/tests/system/providers/docker/example_docker_swarm.html b/...w-providers-docker/3.9.0/_modules/tests/system/providers/docker/example_docker_swarm.html
diff --git a/...er/3.9.0/_sources/_api/airflow/providers/docker/decorators/docker/index.rst.txt b/...er/3.9.0/_sources/_api/airflow/providers/docker/decorators/docker/index.rst.txt
@@ -0,0 +1,30 @@
+:py:mod:`airflow.providers.docker.decorators.docker`
+====================================================
+
+.. py:module:: airflow.providers.docker.decorators.docker
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   airflow.providers.docker.decorators.docker.docker_task
+
+
+
+.. py:function:: docker_task(python_callable = None, multiple_outputs = None, **kwargs)
+
+   Python operator decorator; wraps a function into an Airflow operator.
+
+   Also accepts any argument that DockerOperator will via ``kwargs``. Can be reused in a single DAG.
+
+   :param python_callable: Function to decorate
+   :param multiple_outputs: If set, function return value will be unrolled to multiple XCom values.
+       Dict will unroll to XCom values with keys as XCom keys. Defaults to False.
+
+
diff --git a/...rs-docker/3.9.0/_sources/_api/airflow/providers/docker/decorators/index.rst.txt b/...rs-docker/3.9.0/_sources/_api/airflow/providers/docker/decorators/index.rst.txt
@@ -0,0 +1,15 @@
+:py:mod:`airflow.providers.docker.decorators`
+=============================================
+
+.. py:module:: airflow.providers.docker.decorators
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   docker/index.rst
+
+
diff --git a/...rs-docker/3.9.0/_sources/_api/airflow/providers/docker/exceptions/index.rst.txt b/...rs-docker/3.9.0/_sources/_api/airflow/providers/docker/exceptions/index.rst.txt
@@ -0,0 +1,34 @@
+:py:mod:`airflow.providers.docker.exceptions`
+=============================================
+
+.. py:module:: airflow.providers.docker.exceptions
+
+.. autoapi-nested-parse::
+
+   Exceptions used by Docker provider.
+
+
+
+Module Contents
+---------------
+
+.. py:exception:: DockerContainerFailedException(message = None, logs = None)
+
+
+   Bases: :py:obj:`airflow.exceptions.AirflowException`
+
+   Raised when a Docker container returns an error.
+
+   :param logs: The log output of the failed Docker container
+
+
+.. py:exception:: DockerContainerFailedSkipException(message = None, logs = None)
+
+
+   Bases: :py:obj:`airflow.exceptions.AirflowSkipException`
+
+   Raised when a Docker container returns an error and task should be skipped.
+
+   :param logs: The log output of the failed Docker container
+
+
diff --git a/...-docker/3.9.0/_sources/_api/airflow/providers/docker/hooks/docker/index.rst.txt b/...-docker/3.9.0/_sources/_api/airflow/providers/docker/hooks/docker/index.rst.txt
@@ -0,0 +1,104 @@
+:py:mod:`airflow.providers.docker.hooks.docker`
+===============================================
+
+.. py:module:: airflow.providers.docker.hooks.docker
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   airflow.providers.docker.hooks.docker.DockerHook
+
+
+
+
+.. py:class:: DockerHook(docker_conn_id = default_conn_name, base_url = None, version = None, tls = None, timeout = DEFAULT_TIMEOUT_SECONDS)
+
+
+   Bases: :py:obj:`airflow.hooks.base.BaseHook`
+
+   Interact with a Docker Daemon and Container Registry.
+
+   This class provide a thin wrapper around the ``docker.APIClient``.
+
+   .. seealso::
+       - :ref:`Docker Connection <howto/connection:docker>`
+       - `Docker SDK: Low-level API <https://docker-py.readthedocs.io/en/stable/api.html?low-level-api>`_
+
+   :param docker_conn_id: :ref:`Docker connection id <howto/connection:docker>` where stored credentials
+        to Docker Registry. If set to ``None`` or empty then hook does not login to Container Registry.
+   :param base_url: URL to the Docker server.
+   :param version: The version of the API to use. Use ``auto`` or ``None`` for automatically detect
+       the server's version.
+   :param tls: Is connection required TLS, for enable pass ``True`` for use with default options,
+       or pass a `docker.tls.TLSConfig` object to use custom configurations.
+   :param timeout: Default timeout for API calls, in seconds.
+
+   .. py:property:: client_created
+      :type: bool
+
+      Is api_client created or not.
+
+
+   .. py:attribute:: conn_name_attr
+      :value: 'docker_conn_id'
+
+
+
+   .. py:attribute:: default_conn_name
+      :value: 'docker_default'
+
+
+
+   .. py:attribute:: conn_type
+      :value: 'docker'
+
+
+
+   .. py:attribute:: hook_name
+      :value: 'Docker'
+
+
+
+   .. py:method:: construct_tls_config(ca_cert = None, client_cert = None, client_key = None, verify = True, assert_hostname = None, ssl_version = None)
+      :staticmethod:
+
+      Construct TLSConfig object from parts.
+
+      :param ca_cert: Path to a PEM-encoded CA (Certificate Authority) certificate file.
+      :param client_cert: Path to PEM-encoded certificate file.
+      :param client_key: Path to PEM-encoded key file.
+      :param verify: Set ``True`` to verify the validity of the provided certificate.
+      :param assert_hostname: Hostname to match against the docker server certificate
+          or ``False`` to disable the check.
+      :param ssl_version: Version of SSL to use when communicating with docker daemon.
+
+
+   .. py:method:: api_client()
+
+      Create connection to docker host and return ``docker.APIClient`` (cached).
+
+
+   .. py:method:: get_conn()
+
+      Create connection to docker host and return ``docker.APIClient`` (cached).
+
+
+   .. py:method:: get_connection_form_widgets()
+      :classmethod:
+
+      Return connection form widgets.
+
+
+   .. py:method:: get_ui_field_behaviour()
+      :classmethod:
+
+      Return custom field behaviour.
+
+
+
diff --git a/...oviders-docker/3.9.0/_sources/_api/airflow/providers/docker/hooks/index.rst.txt b/...oviders-docker/3.9.0/_sources/_api/airflow/providers/docker/hooks/index.rst.txt
@@ -0,0 +1,15 @@
+:py:mod:`airflow.providers.docker.hooks`
+========================================
+
+.. py:module:: airflow.providers.docker.hooks
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   docker/index.rst
+
+
diff --git a/...low-providers-docker/3.9.0/_sources/_api/airflow/providers/docker/index.rst.txt b/...low-providers-docker/3.9.0/_sources/_api/airflow/providers/docker/index.rst.txt
@@ -0,0 +1,34 @@
+:py:mod:`airflow.providers.docker`
+==================================
+
+.. py:module:: airflow.providers.docker
+
+
+Subpackages
+-----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+   decorators/index.rst
+   hooks/index.rst
+   operators/index.rst
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   exceptions/index.rst
+
+
+Package Contents
+----------------
+
+.. py:data:: __version__
+   :value: '3.9.0'
+
+
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<html><head><meta http-equiv="refresh" content="0; url=../security.html"/></head></html>