Skip to content

Commit 7764ac9

Browse files
committed
Make overview.rst show only the most important things #52
Add some informational text also.
1 parent 496332e commit 7764ac9

File tree

2 files changed

+22
-48
lines changed

2 files changed

+22
-48
lines changed

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ObjectBox Python API
88
overview
99
API Reference <autoapi/objectbox/index>
1010
ObjectBox Homepage <https://objectbox.io>
11-
ObjectBox docs <https://docs.objectbox.io>
11+
ObjectBox Docs <https://docs.objectbox.io>
1212
GitHub <https://github.com/objectbox/objectbox-python>
1313

1414

doc/overview.rst

Lines changed: 21 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,56 @@
11
API Overview
22
============
3+
4+
This gives an overview of the ObjectBox Python API by showing most important parts to get started.
5+
6+
For beginners, we recommend our `Python database docs <https://docs.objectbox.io/>`_ at for more details;
7+
especially the `Getting Started <https://docs.objectbox.io/getting-started>`_ guide.
8+
This covers more than just the obligatory ``pip install --upgrade objectbox``.
39

410
.. currentmodule:: objectbox
511

6-
Entity Decorator
7-
----------------
12+
Defining the Data Model
13+
-----------------------
14+
15+
The ``@Entity`` decorator is used to define a class as an ObjectBox entity.
816

917
.. autosummary::
1018
:nosignatures:
1119

1220
Entity
1321

14-
15-
Property Types
16-
--------------
22+
Each entity class defines a set of properties. The following property types are most commonly used:
1723

1824
.. autosummary::
1925
:nosignatures:
2026

2127
Id
22-
Bool
2328
String
24-
Bytes
25-
Int8
26-
Int16
2729
Int32
2830
Int64
2931
Float32
3032
Float64
3133
Date
32-
DateNano
33-
Flex
34-
BoolVector
35-
CharVector
36-
Int8Vector
37-
Int16Vector
38-
Int32Vector
39-
Int64Vector
4034
Float32Vector
41-
Float64Vector
42-
BoolList
43-
CharList
44-
Int8List
45-
Int16List
46-
Int32List
47-
Int64List
48-
Float32List
49-
Float64List
5035

51-
52-
Index Types and Flags
53-
---------------------
54-
55-
.. autosummary::
56-
:nosignatures:
57-
58-
Index
59-
HnswIndex
60-
HnswFlags
61-
VectorDistanceType
36+
Note: ``Float32Vector`` is used for `on-device vector search <https://docs.objectbox.io/on-device-vector-search>`_.
6237

6338
Classes
6439
-------
6540

41+
Now, with the data model defined, you can start using the ObjectBox database.
42+
These are the main classes to interact with:
43+
6644
.. autosummary::
6745
:nosignatures:
6846

6947
Store
7048
Box
71-
Model
72-
PropertyQueryCondition
73-
49+
QueryBuilder
50+
Query
7451

75-
Deprecated Interfaces
76-
---------------------
52+
What's next
53+
-----------
7754

78-
.. autosummary::
79-
:nosignatures:
80-
81-
ObjectBox
82-
Builder
55+
* `Python database docs (docs.objectbox.io) <https://docs.objectbox.io/>`_
56+
* API reference (next in this API documentation)

0 commit comments

Comments
 (0)