Readd operators title and TOC in true

Author: WaVEV

docs/source/conf.py

@@ -53,3 +53,4 @@
 
 html_theme = "furo"
 html_static_path = ["_static"]
+toc_object_entries = False

docs/source/ref/models/search.rst

@@ -31,6 +31,9 @@ For the examples in this document, we'll use the following models::
         plot_embedding = ArrayField(models.FloatField(), size=3, null=True)
         writer = EmbeddedModelField(Writer, null=True)
 
+``SearchEquals``
+----------------
+
 .. class:: SearchEquals(path, value, *, score=None)
 
 Matches documents where a field is equal to a given value.
@@ -46,13 +49,12 @@ matches on fields indexed in a MongoDB Atlas Search index.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``value`` (``bool``, :class:`~bson.objectid.ObjectId`, ``int``,
-  :class:`~datetime.datetime`, ``str``, :class:`~uuid.UUID`, ``None``, or
-  :class:`~django.db.models.Value`): The value to match.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``value``: The value to match.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
+
+``SearchAutocomplete``
+----------------------
 
 .. class:: SearchAutocomplete(path, query, *, fuzzy=None, token_order=None, score=None)
 
@@ -73,15 +75,15 @@ in a MongoDB Atlas Search index.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``query`` (``str``, :class:`~django.db.models.Value`): The value to match.
-- ``fuzzy`` (:class:`~typing.Optional`\[:class:`~typing.Dict`\]): Fuzzy
-  matching options, e.g., ``{"maxEdits": 1}``.
+- ``path``: The document path to the field.
+- ``query``: The value to match.
+- ``fuzzy``: Fuzzy matching options, e.g., ``{"maxEdits": 1}``.
 - ``token_order``: Controls token sequence behavior. Accepts values like
   ``"sequential"`` or ``"any"``.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
+
+``SearchExists``
+----------------
 
 .. class:: SearchExists(path, *, score=None)
 
@@ -102,10 +104,11 @@ documents that include (or exclude) optional fields.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
+
+``SearchIn``
+------------
 
 .. class:: SearchIn(path, value, *, score=None)
 
@@ -125,13 +128,12 @@ field contains a value from the provided array.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``value`` (``bool``, ``int``, ``str``, :class:`~bson.objectid.ObjectId`,
-  :class:`~datetime.datetime`, :class:`~uuid.UUID`, or
-  :class:`~django.db.models.Value`): The value to match.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``value``: The value to match.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
+
+``SearchPhrase``
+----------------
 
 .. class:: SearchPhrase(path, query, *, slop=None, synonyms=None, score=None)
 
@@ -154,16 +156,14 @@ synonym mappings defined in the Atlas Search index.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``query`` (``str``, :class:`~django.db.models.Value`): The value to match.
-- ``slop`` (``Optional[int]``): The maximum number of
-  terms allowed between phrase terms.
-- ``synonyms`` (``Optional[str]``): The name of a synonym
-  mapping defined in your Atlas index.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``query``: The value to match.
+- ``slop``: The maximum number of terms allowed between phrase terms.
+- ``synonyms``: The name of a synonym mapping defined in your Atlas index.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
 
+``SearchQueryString``
+---------------------
 
 .. class:: SearchQueryString(path, query, *, score=None)
 
@@ -186,12 +186,13 @@ supports features like boolean operators, wildcards, and field-specific terms.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``query`` (``str``, :class:`~django.db.models.Value`): argument is a
-  Lucene-style query string.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]): Tunes
-  the relevance score.
+- ``path``: The document path to the field.
+- ``query``: A Lucene-style query string.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
+
+
+``SearchRange``
+---------------
 
 .. class:: SearchRange(path, *, lt=None, lte=None, gt=None, gte=None, score=None)
 
@@ -211,22 +212,15 @@ date, or other comparable fields based on upper and/or lower bounds.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``lt`` (``bool``, :class:`~bson.objectid.ObjectId`, ``int``,
-  :class:`~datetime.datetime`, ``str``, :class:`~uuid.UUID`, or
-  :class:`~django.db.models.Value`): Exclusive upper bound (``<``)
-- ``lte`` (``bool``, :class:`~bson.objectid.ObjectId`, ``int``,
-  :class:`~datetime.datetime`, ``str``, :class:`~uuid.UUID`, or
-  :class:`~django.db.models.Value`): Inclusive upper bound (``<=``)
-- ``gt`` (``bool``, :class:`~bson.objectid.ObjectId`, ``int``,
-  :class:`~datetime.datetime`, ``str``, :class:`~uuid.UUID`, or
-  :class:`~django.db.models.Value`): Exclusive lower bound (``>``)
-- ``gte`` (``bool``, :class:`~bson.objectid.ObjectId`, ``int``,
-  :class:`~datetime.datetime`, ``str``, :class:`~uuid.UUID`, or
-  :class:`~django.db.models.Value`): Inclusive lower bound (``>=``)
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``lt``: Exclusive upper bound (``<``)
+- ``lte``: Inclusive upper bound (``<=``)
+- ``gt``: Exclusive lower bound (``>``)
+- ``gte``: Inclusive lower bound (``>=``)
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
+
+``SearchRegex``
+---------------
 
 .. class:: SearchRegex(path, query, *, allow_analyzed_field=None, score=None)
 
@@ -246,14 +240,15 @@ expression pattern to the contents of a specified field.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``query`` (``str``, :class:`~django.db.models.Value`): regular expression
-  string that will be applied to the field contents.
-- ``allow_analyzed_field`` (``Optional[bool]``): Boolean
-  indicating whether to allow matching against analyzed fields.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``query``: Regular expression string that will be applied to the field
+  contents.
+- ``allow_analyzed_field``: Boolean indicating whether to allow matching
+  against analyzed fields.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
+
+``SearchText``
+--------------
 
 .. class:: SearchText(path, query, *, fuzzy=None, match_criteria=None, synonyms=None, score=None)
 
@@ -278,17 +273,15 @@ criteria, and synonym mappings.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``query`` (``str``, :class:`~django.db.models.Value`): argument
-  is the search term or phrase.
-- ``fuzzy`` (``Optional[Dict]``): A dictionary of fuzzy
-  matching options, such as ``{"maxEdits": 1}``.
-- ``synonyms`` (``Optional[str]``): The name of a synonym
-  mapping defined in your Atlas index.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``query``: The argument is the search term or phrase.
+- ``fuzzy``: A dictionary of fuzzy matching options, such as
+  ``{"maxEdits": 1}``.
+- ``synonyms``: The name of a synonym mapping defined in your Atlas index.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
 
+``SearchWildcard``
+------------------
 
 .. class:: SearchWildcard(path, query, allow_analyzed_field=None, score=None)
 
@@ -311,14 +304,14 @@ terms matching a pattern with ``*`` (any sequence of characters) and ``?``
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``query`` (``str``, :class:`~django.db.models.Value`): is a wildcard string
-  that may include ``*`` and ``?``.
-- ``allow_analyzed_field`` (``Optional[bool]``): Boolean
-  indicating whether to allow matching against analyzed fields.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``query``: A wildcard string that may include ``*`` and ``?``.
+- ``allow_analyzed_field``: Boolean indicating whether to allow matching
+  against analyzed fields.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
+
+``SearchGeoShape``
+------------------
 
 .. class:: SearchGeoShape(path, relation, geometry, *, score=None)
 
@@ -342,14 +335,14 @@ GeoJSON geometry.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``relation`` (``str``): The spatial relation to test. Valid
-  values include ``"within"``, ``"intersects"``, and ``"disjoint"``.
-- ``geometry`` (``Dict``): A GeoJSON geometry object to compare against.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``relation``: The spatial relation to test. Valid values include
+  ``"within"``, ``"intersects"``, and ``"disjoint"``.
+- ``geometry``: A GeoJSON geometry object to compare against.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
 
+``SearchGeoWithin``
+-------------------
 
 .. class:: SearchGeoWithin(path, kind, geometry, *, score=None)
 
@@ -373,15 +366,13 @@ geometry.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``kind`` (``str``): The GeoJSON geometry type ``circle``, ``box``, or
-  ``geometry``.
-- ``geo_object`` (``Dict``): The GeoJSON geometry defining the spatial
-  boundary.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``path``: The document path to the field.
+- ``kind``: The GeoJSON geometry type ``circle``, ``box``, or ``geometry``.
+- ``geo_object``: The GeoJSON geometry defining the spatial boundary.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
 
+``SearchMoreLikeThis``
+----------------------
 
 .. class:: SearchMoreLikeThis(documents, *, score=None)
 
@@ -406,10 +397,9 @@ retrieve documents that resemble one or more example documents.
 
 **Arguments:**
 
-- ``documents`` (``List[Dict]``): List of example documents or expressions
+- ``documents``: List of example documents or expressions
   that serve as references for similarity.
-- ``score`` (:class:`~typing.Optional`\[:class:`SearchScoreOption`\]):
-  Tunes the relevance score.
+- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
 
 
 ``CompoundExpression``
@@ -440,21 +430,19 @@ contribute to document matching and scoring.
 
 **Arguments:**
 
-- ``must`` (``List[SearchExpression])``): List of expressions that **must**
+- ``must``: List of expressions that **must** match.
+- ``must_not``: List of expressions that **must not** match.
+- ``should``: List of optional expressions that **should** match. These can
+  improve scoring.
+- ``filter``: List of expressions used for filtering without affecting
+  relevance scoring.
+- ``minimum_should_match``: The minimum number of ``should`` clauses that must
   match.
-- ``must_not`` (``List[SearchExpression]``): List of expressions that
-  **must not** match.
-- ``should`` (``List[SearchExpression]``): List of optional expressions that
-  **should** match. These can improve scoring.
-- ``filter`` (``List[SearchExpression]``): List of expressions used for
-  filtering without affecting relevance scoring.
-- ``minimum_should_match`` (``Optional[int]``): The minimum number of
-  ``should`` clauses that must match.
 - ``score``: A :class:`SearchScoreOption` to tune the relevance score.
 
 
-Combinable expressions
-----------------------
+``Combinable expressions``
+--------------------------
 
 All Atlas Search expressions subclassed from ``SearchExpression``
 can be combined using Python's bitwise operators:
@@ -502,17 +490,13 @@ vector, using either approximate or exact nearest-neighbor search.
 
 **Arguments:**
 
-- ``path`` (``str`` or :class:`~django.db.models.F`): The document path
-  to the field.
-- ``query_vector`` (``List[float | int]``): The input vector used for
-  similarity comparison.
-- ``limit`` (``int``): The maximum number of matching documents to return.
-- ``num_candidates`` (``int``): The number of candidate documents considered
-  during search.
-- ``exact`` (``bool``):  Whether to enforce exact search instead of
-  approximate.
-- ``filter`` (``dict``): A filter MQL expression to restrict the candidate
-  documents.
+- ``path``: The document path to the field.
+- ``query_vector``: The input vector used for similarity comparison.
+- ``limit``: The maximum number of matching documents to return.
+- ``num_candidates``: The number of candidate documents considered during
+  search.
+- ``exact``:  A boolean whether to enforce exact search instead of approximate.
+- ``filter``: A MQL filter expression to restrict the candidate documents.
 
 .. warning::