[Docs] SynchronousFlyteClient API reference #3095 (#1416)

Signed-off-by: Peeter Piegaze <[email protected]> Signed-off-by: Peeter Piegaze <[email protected]> Co-authored-by: Peeter Piegaze <[email protected]> Co-authored-by: Haytham Abuelfutuh <[email protected]>
flyteorg · Feb 22, 2023 · 451786a · 451786a
1 parent acfa7cc
commit 451786a
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/docs/source/clients.rst 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
@@ -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
@@ -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
+"""
-Original file line number
+Diff line change
@@ Expand Up / @@ -76,6 +76,7 @@ Expected output: @@
        flytekit
        configuration
        remote
+       clients
        testing
        extend
        deck
@@ Expand Down @@