docs: added API overview #52

dan-obx · dan-obx · commit 496332efbd3a · 2024-05-31T14:24:34.000+02:00
diff --git a/doc/index.rst b/doc/index.rst
@@ -5,7 +5,8 @@ ObjectBox Python API
    :maxdepth: 1
    :caption: Contents:
 
-   Python API Reference <autoapi/objectbox/index>
+   overview
+   API Reference <autoapi/objectbox/index>
    ObjectBox Homepage <https://objectbox.io>
    ObjectBox docs <https://docs.objectbox.io>
    GitHub <https://github.com/objectbox/objectbox-python>
diff --git a/doc/overview.rst b/doc/overview.rst
@@ -0,0 +1,82 @@
+API Overview
+============
+    
+    .. currentmodule:: objectbox
+
+Entity Decorator
+----------------
+
+  .. autosummary:: 
+        :nosignatures:
+
+        Entity
+
+
+Property Types
+--------------
+
+  .. autosummary:: 
+        :nosignatures:
+
+        Id
+        Bool
+        String
+        Bytes
+        Int8
+        Int16
+        Int32
+        Int64
+        Float32
+        Float64
+        Date
+        DateNano
+        Flex
+        BoolVector
+        CharVector
+        Int8Vector
+        Int16Vector
+        Int32Vector
+        Int64Vector
+        Float32Vector
+        Float64Vector
+        BoolList
+        CharList
+        Int8List
+        Int16List
+        Int32List
+        Int64List
+        Float32List
+        Float64List
+
+
+Index Types and Flags
+---------------------
+        
+  .. autosummary:: 
+        :nosignatures:
+        
+        Index
+        HnswIndex
+        HnswFlags
+        VectorDistanceType
+
+Classes
+-------
+
+    .. autosummary::
+        :nosignatures:
+        
+        Store
+        Box
+        Model
+        PropertyQueryCondition
+
+
+Deprecated Interfaces
+---------------------
+
+    .. autosummary::
+        :nosignatures:
+        
+        ObjectBox
+        Builder
diff --git a/doc/setup.sh b/doc/setup.sh
@@ -1,3 +1,4 @@
 python3 -m venv .venv
 source .venv/bin/activate
 pip install -r requirements.txt
+pip install -e ..
