updated documentation

Former-commit-id: 26e83b3 [formerly 9ce24e8b579d24637ec9c2db9a2148131031665c] Former-commit-id: 5a7ffb9 Former-commit-id: a961a98 Former-commit-id: 775ae1b8c2c87f0bff43d75275466a11e4e2a7d2 Former-commit-id: 64058fd110eea590f8c09cb2ab2c656a69f5ada7
franioli · Sep 18, 2023 · ce6c0cb · ce6c0cb
1 parent a4b744b
commit ce6c0cb
Show file tree

Hide file tree

Showing 16 changed files with 190 additions and 267 deletions.
diff --git a/docs/classes/camera.md b/docs/classes/camera.md
diff --git a/docs/classes/epoch.md b/docs/classes/epoch.md
diff --git a/docs/classes/features.md b/docs/classes/features.md
diff --git a/docs/classes/images.md b/docs/classes/images.md
diff --git a/docs/classes/point_cloud.md b/docs/classes/point_cloud.md
diff --git a/docs/classes/points.md b/docs/classes/points.md
diff --git a/docs/core/camera.md b/docs/core/camera.md
@@ -0,0 +1,18 @@
+# Camera
+
+You can import icepy4d classes by
+
+```python
+from icepy4d import core as icecore
+```
+
+and directly access to the Camera class by
+
+```python
+icecore.Camera
+```
+
+::: icepy4d.core.camera.Camera
+    options:
+      show_root_heading: true
+      members:
diff --git a/docs/core/epoch.md b/docs/core/epoch.md
@@ -0,0 +1,31 @@
+# Epoch
+
+You can import icepy4d core module by
+
+```python
+from icepy4d import core as icecore
+```
+
+and directly access to the Epoch and Epoches class by
+
+```python
+icecore.Epoch
+```
+
+::: icepy4d.core.epoch.EpochDataMap
+    options:
+      show_root_heading: true
+      show_source: true
+      members:
+
+::: icepy4d.core.epoch.Epoch
+    options:
+      show_root_heading: true
+      show_source: true
+      members:
+
+::: icepy4d.core.epoch.Epoches
+    options:
+      show_root_heading: true
+      show_source: true
+      members:
diff --git a/docs/core/features.md b/docs/core/features.md
@@ -0,0 +1,25 @@
+# Feature and Features classes
+
+You can import icepy4d classes by
+
+```python
+import icepy4d.core as icecore
+```
+
+and directly access to the Image and ImageDS classes by
+
+```python
+icecore.Feature
+```
+
+::: icepy4d.core.features.Feature
+    options:
+      show_root_heading: true
+      show_source: true
+      members:
+
+::: icepy4d.core.features.Features
+    options:
+      show_root_heading: true
+      show_source: true
+      members:
diff --git a/docs/core/images.md b/docs/core/images.md
@@ -0,0 +1,26 @@
+# Image and ImageDS classes
+
+You can import icepy4d classes by
+
+```python
+import icepy4d.core as icecore
+```
+
+and directly access to the Image and ImageDS classes by
+
+```python
+icecore.Image
+```
+
+::: icepy4d.core.images.Image
+    options:
+      show_root_heading: true
+      show_source: true
+      members:
+
+::: icepy4d.core.images.ImageDS
+    options:
+      show_root_heading: true
+      show_source: true
+      members:
+
diff --git a/docs/core/point_cloud.md b/docs/core/point_cloud.md
@@ -0,0 +1,19 @@
+# PointCloud Class
+
+You can import icepy4d classes by
+
+```python
+import icepy4d.core as icecore
+```
+
+and directly access to the Image and ImageDS classes by
+
+```python
+icecore.PointCloud
+```
+
+::: icepy4d.core.point_cloud.PointCloud
+    options:
+      show_root_heading: true
+      show_source: true
+      members: