From 1003620777b99ffa7930ef87756e943450ef3433 Mon Sep 17 00:00:00 2001 From: Nikki Everett Date: Fri, 12 Apr 2024 15:19:05 -0500 Subject: [PATCH] add imagespec reference docs to flyte docs (#2347) Signed-off-by: nikki everett Signed-off-by: Jan Fiedler --- docs/source/docs_index.rst | 1 + docs/source/imagespec.rst | 4 ++++ flytekit/image_spec/__init__.py | 15 +++++++++++++++ 3 files changed, 20 insertions(+) create mode 100644 docs/source/imagespec.rst diff --git a/docs/source/docs_index.rst b/docs/source/docs_index.rst index dbbf95af83..9e1f8b3ecc 100644 --- a/docs/source/docs_index.rst +++ b/docs/source/docs_index.rst @@ -8,6 +8,7 @@ Flytekit API Reference design/index flytekit configuration + imagespec remote clients testing diff --git a/docs/source/imagespec.rst b/docs/source/imagespec.rst new file mode 100644 index 0000000000..cfeabf353b --- /dev/null +++ b/docs/source/imagespec.rst @@ -0,0 +1,4 @@ +.. automodule:: flytekit.image_spec + :no-members: + :no-inherited-members: + :no-special-members: diff --git a/flytekit/image_spec/__init__.py b/flytekit/image_spec/__init__.py index ca1bdedee6..0495487a82 100644 --- a/flytekit/image_spec/__init__.py +++ b/flytekit/image_spec/__init__.py @@ -1 +1,16 @@ +""" +========== +ImageSpec +========== + +.. currentmodule:: flytekit.image_spec + +This module contains the ImageSpec class parameters and methods. + +.. autosummary:: + :toctree: generated/ + + ImageSpec +""" + from .image_spec import ImageSpec