From 9f12ee481f064055f5f2a7b19e6bb454421f73f8 Mon Sep 17 00:00:00 2001 From: fanchengyan Date: Tue, 23 Jan 2024 15:40:13 +0800 Subject: [PATCH] add pairs/loops in docs --- docs/source/api/index.rst | 1 + docs/source/api/insar_class/pairs.rst | 27 +++++++++++++++++++++++++++ docs/source/user_guide/index.rst | 2 +- 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 docs/source/api/insar_class/pairs.rst diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst index ed8a3ef..3de40f4 100644 --- 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 new file mode 100644 index 0000000..ee9e34d --- /dev/null +++ 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: \ No newline at end of file diff --git a/docs/source/user_guide/index.rst b/docs/source/user_guide/index.rst index e9350dc..fb08ec6 100644 --- 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 +