add pairs/loops in docs

Fanchengyan · Jan 23, 2024 · 9f12ee4 · 9f12ee4
1 parent 8f569ea
commit 9f12ee4
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 1 deletion.
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -8,5 +8,6 @@ Python API Reference
    query/query
    samplers/index
    NSBAS/index
+   insar_class/pairs
 
 
diff --git a/docs/source/api/insar_class/pairs.rst b/docs/source/api/insar_class/pairs.rst
@@ -0,0 +1,27 @@
+Pairs and Loops
+===============
+
+
+.. autoclass:: faninsar.Pairs
+   :members:
+   :undoc-members:
+   :member-order: bysource
+   :show-inheritance:
+
+.. autoclass:: faninsar.Loop
+   :members:
+   :undoc-members:
+   :member-order: bysource
+   :show-inheritance:
+
+.. autoclass:: faninsar.TripletLoops
+   :members:
+   :undoc-members:
+   :member-order: bysource
+   :show-inheritance:
+
+.. autoclass:: faninsar.PairsFactory
+   :members:
+   :undoc-members:
+   :member-order: bysource
+   :show-inheritance:
diff --git a/docs/source/user_guide/index.rst b/docs/source/user_guide/index.rst
@@ -10,7 +10,7 @@ examples that describe many common tasks that you can accomplish with FanSAR.
    :maxdepth: 2
    :hidden:
 
-
    data_structures
    Indexing_data
+