Skip to content

Commit e69da64

Browse files
timgrahamWaVEV
authored andcommitted
stub docs
1 parent 2b90b8c commit e69da64

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed

docs/source/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Models
3838
- :doc:`ref/models/fields`
3939
- :doc:`ref/models/querysets`
4040
- :doc:`ref/models/models`
41+
- :doc:`ref/models/indexes`
4142

4243
**Topic guides:**
4344

docs/source/ref/models/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ Model API reference.
1010
fields
1111
querysets
1212
models
13+
indexes

docs/source/ref/models/indexes.rst

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
=====================
2+
Model index reference
3+
=====================
4+
5+
.. module:: django_mongodb_backend.indexes
6+
:synopsis: Database indexes for MongoDB.
7+
8+
Some MongoDB-specific indexes are available in
9+
``django_mongodb_backend.indexes``.
10+
11+
``SearchIndex``
12+
===============
13+
14+
.. class:: SearchIndex(*expressions, **kwargs)
15+
16+
...
17+
18+
19+
``VectorSearchIndex``
20+
=====================
21+
22+
.. class:: VectorSearchIndex(*expressions, similarities="cosine", **kwargs)
23+
24+
Available values for ``similarities`` are ``"euclidean"``, ``"cosine"``, and
25+
``"dotProduct"``.
26+
27+
...

0 commit comments

Comments
 (0)