From 27011b0202345d2ad7fd6074122070d88c360eae Mon Sep 17 00:00:00 2001 From: Peeter Piegaze Date: Fri, 20 Jan 2023 18:03:07 +0100 Subject: [PATCH] [Docs] SynchronousFlyteClient API reference #3095 Signed-off-by: Peeter Piegaze --- docs/source/clients.rst | 4 ++++ docs/source/index.rst | 1 + flytekit/clients/__init__.py | 19 +++++++++++++++++++ 3 files changed, 24 insertions(+) create mode 100644 docs/source/clients.rst diff --git a/docs/source/clients.rst b/docs/source/clients.rst new file mode 100644 index 0000000000..f67ebf6a3a --- /dev/null +++ b/docs/source/clients.rst @@ -0,0 +1,4 @@ +.. automodule:: flytekit.clients + :no-members: + :no-inherited-members: + :no-special-members: diff --git a/docs/source/index.rst b/docs/source/index.rst index b0d46866fa..db5902391b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -76,6 +76,7 @@ Expected output: flytekit configuration remote + clients testing extend deck diff --git a/flytekit/clients/__init__.py b/flytekit/clients/__init__.py index e69de29bb2..1b08e1c567 100644 --- a/flytekit/clients/__init__.py +++ b/flytekit/clients/__init__.py @@ -0,0 +1,19 @@ +""" +===================== +Clients +===================== + +.. currentmodule:: flytekit.clients + +This module provides lower level access to a Flyte backend. + +.. _clients_module: + +.. autosummary:: + :template: custom.rst + :toctree: generated/ + :nosignatures: + + ~friendly.SynchronousFlyteClient + ~raw.RawSynchronousFlyteClient +"""