summaryrefslogtreecommitdiff
path: root/searx/enginelib
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/enginelib
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/enginelib')
-rw-r--r--searx/enginelib/__init__.py17
1 files changed, 7 insertions, 10 deletions
diff --git a/searx/enginelib/__init__.py b/searx/enginelib/__init__.py
index fd3019e6c..6a0bb67c5 100644
--- a/searx/enginelib/__init__.py
+++ b/searx/enginelib/__init__.py
@@ -1,18 +1,15 @@
# SPDX-License-Identifier: AGPL-3.0-or-later
# lint: pylint
-"""Engine related implementations
+"""Implementations of the framework for the SearXNG engines.
-.. note::
+.. hint::
- The long term goal is to modularize all relevant implementations to the
- engines here in this Python package. In addition to improved modularization,
- this will also be necessary in part because the probability of circular
- imports will increase due to the increased typification of implementations in
- the future.
+ The long term goal is to modularize all implementations of the engine
+ framework here in this Python package. ToDo:
- ToDo:
+ - move implementations of the :ref:`searx.engines loader` to a new module in
+ the :py:obj:`searx.enginelib` namespace.
- - move :py:obj:`searx.engines.load_engine` to a new module `searx.enginelib`.
"""
@@ -36,7 +33,7 @@ class Engine: # pylint: disable=too-few-public-methods
# Common options in the engine module
engine_type: str
- """Type of the engine (:origin:`searx/search/processors`)"""
+ """Type of the engine (:ref:`searx.search.processors`)"""
paging: bool
"""Engine supports multiple pages."""