Documentation: Add api for distributed utils

hyperspy · Nov 28, 2023 · da7bb10 · da7bb10
1 parent 4a08299
commit da7bb10
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/api/utils.rst b/docs/api/utils.rst
@@ -19,4 +19,12 @@ Test utility functions
 ^^^^^^^^^^^^^^^^^^^^^^
 
 .. automodule:: rsciio.tests.registry_utils
-   :members:
+   :members:
+
+Distributed utility functions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: rsciio.utils.distributed
+   :members:
+
+"""
diff --git a/upcoming_changes/162.new.rst b/upcoming_changes/162.new.rst
@@ -1,4 +1,4 @@
-Added the :py:func:`~rsciio.utils.distributed.memmap_distributed` function for loading a memmap file
+Added the :func:`~rsciio.utils.distributed.memmap_distributed` function for loading a memmap file
 from multiple processes.
 
 Added the arguments ``distributed`` and ``metadata_file`` to the .mrc file reader for loading metadata