DOC-648 Add pages for Neptune and W&B plugins (flyteorg#2803)

* add pages for neptune and wandb plugins Signed-off-by: nikki everett <[email protected]> * add autosummary sections to init files Signed-off-by: nikki everett <[email protected]> * don't render the TOC twice Signed-off-by: nikki everett <[email protected]> --------- Signed-off-by: nikki everett <[email protected]>
otarabai · Oct 15, 2024 · 4bf57ae · 4bf57ae
1 parent af3a18f
commit 4bf57ae
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 1 deletion.
diff --git a/docs/source/plugins/index.rst b/docs/source/plugins/index.rst
@@ -33,10 +33,12 @@ Plugin API reference
 * :ref:`SageMaker Inference <awssagemaker_inference>` - SageMaker Inference API reference
 * :ref:`OpenAI <openai>` - OpenAI API reference
 * :ref:`Inference <inference>` - Inference API reference
+* :ref:`Neptune <neptune>` - Neptune API reference
+* :ref:`Weights & Biases <wandb>` - Weights & Biases API reference
 
 .. toctree::
    :maxdepth: 2
-   :caption: API reference
+   :hidden:
 
    AWS Athena <athena>
    AWS Batch <awsbatch>
@@ -67,3 +69,5 @@ Plugin API reference
    SageMaker Inference <awssagemaker_inference>
    OpenAI <openai>
    Inference <inference>
+   Neptune <neptune>
+   Weights & Biases <wandb>
diff --git a/docs/source/plugins/neptune.rst b/docs/source/plugins/neptune.rst
@@ -0,0 +1,12 @@
+.. _neptune:
+
+###################################################
+Neptune API reference
+###################################################
+
+.. tags:: Integration
+
+.. automodule:: flytekitplugins.neptune
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/docs/source/plugins/wandb.rst b/docs/source/plugins/wandb.rst
@@ -0,0 +1,12 @@
+.. _wandb:
+
+###################################################
+Weights & Biases API reference
+###################################################
+
+.. tags:: Integration
+
+.. automodule:: flytekitplugins.wandb
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/plugins/flytekit-neptune/flytekitplugins/neptune/__init__.py b/plugins/flytekit-neptune/flytekitplugins/neptune/__init__.py
@@ -1,3 +1,15 @@
+"""
+.. currentmodule:: flytekitplugins.neptune
+
+This package contains things that are useful when extending Flytekit.
+
+.. autosummary::
+   :template: custom.rst
+   :toctree: generated/
+
+   neptune_init_run
+"""
+
 from .tracking import neptune_init_run
 
 __all__ = ["neptune_init_run"]
diff --git a/plugins/flytekit-wandb/flytekitplugins/wandb/__init__.py b/plugins/flytekit-wandb/flytekitplugins/wandb/__init__.py
@@ -1,3 +1,15 @@
+"""
+.. currentmodule:: flytekitplugins.wandb
+
+This package contains things that are useful when extending Flytekit.
+
+.. autosummary::
+   :template: custom.rst
+   :toctree: generated/
+
+   wandb_init
+"""
+
 from .tracking import wandb_init
 
 __all__ = ["wandb_init"]