Add memray integration to API docs (dask#8115)

crusaderky · Aug 17, 2023 · a356fb8 · a356fb8
1 parent c72e8ae
commit a356fb8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -6,3 +6,4 @@ git+https://github.com/dask/dask
 sphinx
 dask-sphinx-theme>=3.0.0
 sphinx-click
+memray
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -75,6 +75,8 @@ The client connects to and submits computation to a Dask cluster (such as a :cla
 .. autosummary::
    distributed.utils.Log
    distributed.utils.Logs
+   distributed.diagnostics.memray.memray_scheduler
+   distributed.diagnostics.memray.memray_workers
 
 
 Asynchronous methods
@@ -199,6 +201,8 @@ Utilities
 
 .. autoclass:: distributed.utils.Log
 .. autoclass:: distributed.utils.Logs
+.. autofunction:: distributed.diagnostics.memray.memray_scheduler
+.. autofunction:: distributed.diagnostics.memray.memray_workers
 
 
 Adaptive