Add grid and Gerchberg-Saxton in documentation

LASY-org · Oct 27, 2023 · 15f57c8 · 15f57c8
1 parent 13afcfa
commit 15f57c8
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -80,3 +80,4 @@ The code is open-source and hosted on `github <https://github.com/LASY-org/lasy>
    code_overview/index
    api/index
    tutorials/index
+   utils/index
diff --git a/docs/source/utils/gerchberg_saxton.rst b/docs/source/utils/gerchberg_saxton.rst
@@ -0,0 +1,4 @@
+Gerchberg-Saxton phase retrieval
+================================
+
+.. autofunction:: lasy.utils.phase_retrieval.gerchberg_saxton
diff --git a/docs/source/utils/grid.rst b/docs/source/utils/grid.rst
@@ -0,0 +1,5 @@
+Grid
+====
+
+.. autoclass:: lasy.utils.grid.Grid
+    :members:
diff --git a/docs/source/utils/index.rst b/docs/source/utils/index.rst
@@ -0,0 +1,9 @@
+Utils
+=====
+
+.. toctree::
+   :maxdepth: 4
+   :hidden:
+
+   grid
+   gerchberg_saxton