From 051c1819437ce727e6cffc124620f4499babcd74 Mon Sep 17 00:00:00 2001
From: Jan Fiedler <jan@union.ai>
Date: Thu, 7 Nov 2024 17:27:47 -0800
Subject: [PATCH] plugin docs

Signed-off-by: Jan Fiedler <jan@union.ai>
---
 docs/source/plugins/index.rst                        |  2 ++
 docs/source/plugins/memray.rst                       | 12 ++++++++++++
 .../flytekitplugins/memray/__init__.py               | 12 ++++++++++++
 3 files changed, 26 insertions(+)
 create mode 100644 docs/source/plugins/memray.rst

diff --git a/docs/source/plugins/index.rst b/docs/source/plugins/index.rst
index 6f58ebd2d3..1d506e9499 100644
--- a/docs/source/plugins/index.rst
+++ b/docs/source/plugins/index.rst
@@ -29,6 +29,7 @@ Plugin API reference
 * :ref:`Ray <ray>` - Ray API reference
 * :ref:`DBT <dbt>` - DBT API reference
 * :ref:`Vaex <vaex>` - Vaex API reference
+* :ref:`Memray <memray>` - Memray API reference
 * :ref:`MLflow <mlflow>` - MLflow API reference
 * :ref:`DuckDB <duckdb>` - DuckDB API reference
 * :ref:`SageMaker Inference <awssagemaker_inference>` - SageMaker Inference API reference
@@ -66,6 +67,7 @@ Plugin API reference
    Ray <ray>
    DBT <dbt>
    Vaex <vaex>
+   Memray <memray>
    MLflow <mlflow>
    DuckDB <duckdb>
    SageMaker Inference <awssagemaker_inference>
diff --git a/docs/source/plugins/memray.rst b/docs/source/plugins/memray.rst
new file mode 100644
index 0000000000..51be929ba8
--- /dev/null
+++ b/docs/source/plugins/memray.rst
@@ -0,0 +1,12 @@
+.. _memray:
+
+###################################################
+Memray API reference
+###################################################
+
+.. tags:: Integration, Profiling, Observability
+
+.. automodule:: flytekitplugins.memray
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/plugins/flytekit-memray/flytekitplugins/memray/__init__.py b/plugins/flytekit-memray/flytekitplugins/memray/__init__.py
index 85bfdf0952..1e6270d370 100644
--- a/plugins/flytekit-memray/flytekitplugins/memray/__init__.py
+++ b/plugins/flytekit-memray/flytekitplugins/memray/__init__.py
@@ -1,3 +1,15 @@
+"""
+.. currentmodule:: flytekitplugins.memray
+
+This package contains things that are useful when extending Flytekit.
+
+.. autosummary::
+   :template: custom.rst
+   :toctree: generated/
+
+   memray_profiling
+"""
+
 from .profiling import memray_profiling
 
 __all__ = ["memray_profiling"]