summaryrefslogtreecommitdiff
path: root/searx/engines/meilisearch.py
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2023-06-30 18:07:02 +0200
committerMarkus Heiser <markus.heiser@darmarIT.de>2023-07-01 22:45:19 +0200
commit5720844fcdc8601798e10544e2fd25ce4f2ad099 (patch)
treeaf611e4aef436253f4fda9504d06e05e2621114d /searx/engines/meilisearch.py
parent8e8d8dabe9b17c9db8db7432c6bc063d9ae980d1 (diff)
downloadsearxng-5720844fcdc8601798e10544e2fd25ce4f2ad099.tar.gz
searxng-5720844fcdc8601798e10544e2fd25ce4f2ad099.zip
[doc] rearranges Settings & Engines docs for better readability
We have built up detailed documentation of the *settings* and the *engines* over the past few years. However, this documentation was still spread over various chapters and was difficult to navigate in its entirety. This patch rearranges the Settings & Engines documentation for better readability. To review new ordered docs:: make docs.clean docs.live Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'searx/engines/meilisearch.py')
-rw-r--r--searx/engines/meilisearch.py32
1 files changed, 30 insertions, 2 deletions
diff --git a/searx/engines/meilisearch.py b/searx/engines/meilisearch.py
index c41d23eb4..0c2370216 100644
--- a/searx/engines/meilisearch.py
+++ b/searx/engines/meilisearch.py
@@ -1,7 +1,35 @@
# SPDX-License-Identifier: AGPL-3.0-or-later
# lint: pylint
-"""
- Meilisearch
+""".. sidebar:: info
+
+ - :origin:`meilisearch.py <searx/engines/meilisearch.py>`
+ - `MeiliSearch <https://www.meilisearch.com>`_
+ - `MeiliSearch Documentation <https://docs.meilisearch.com/>`_
+ - `Install MeiliSearch
+ <https://docs.meilisearch.com/learn/getting_started/installation.html>`_
+
+MeiliSearch_ is aimed at individuals and small companies. It is designed for
+small-scale (less than 10 million documents) data collections. E.g. it is great
+for storing web pages you have visited and searching in the contents later.
+
+The engine supports faceted search, so you can search in a subset of documents
+of the collection. Furthermore, you can search in MeiliSearch_ instances that
+require authentication by setting ``auth_token``.
+
+Example
+=======
+
+Here is a simple example to query a Meilisearch instance:
+
+.. code:: yaml
+
+ - name: meilisearch
+ engine: meilisearch
+ shortcut: mes
+ base_url: http://localhost:7700
+ index: my-index
+ enable_http: true
+
"""
# pylint: disable=global-statement