Skip to content

Commit

Permalink
plugin docs
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Fiedler <[email protected]>
  • Loading branch information
fiedlerNr9 committed Nov 11, 2024
1 parent dfd0fe2 commit 051c181
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -66,6 +67,7 @@ Plugin API reference
Ray <ray>
DBT <dbt>
Vaex <vaex>
Memray <memray>
MLflow <mlflow>
DuckDB <duckdb>
SageMaker Inference <awssagemaker_inference>
Expand Down
12 changes: 12 additions & 0 deletions docs/source/plugins/memray.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _memray:

###################################################
Memray API reference
###################################################

.. tags:: Integration, Profiling, Observability

.. automodule:: flytekitplugins.memray
:no-members:
:no-inherited-members:
:no-special-members:
12 changes: 12 additions & 0 deletions plugins/flytekit-memray/flytekitplugins/memray/__init__.py
Original file line number Diff line number Diff line change
@@ -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"]

0 comments on commit 051c181

Please sign in to comment.