summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-06-04 11:29:58 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2021-06-04 15:05:58 +0200
commit340d25b19b53582ee6465796d83eb419d2862dcc (patch)
tree23c8f5858490e710dbfcdd3bae955ecadc655ff2 /docs
parentc647c8b7a594864a3cfbc881a9bb80efde9d73cf (diff)
downloadsearxng-340d25b19b53582ee6465796d83eb419d2862dcc.tar.gz
searxng-340d25b19b53582ee6465796d83eb419d2862dcc.zip
[docs] rename 'General Engine Settings' to 'Configured Engines'
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs')
-rw-r--r--docs/admin/engines/configured_engines.rst (renamed from docs/admin/engines/engine_settings.rst)49
-rw-r--r--docs/admin/engines/index.rst2
-rw-r--r--docs/admin/settings.rst2
-rw-r--r--docs/dev/engine_overview.rst2
-rw-r--r--docs/dev/reST.rst4
-rw-r--r--docs/dev/search_api.rst2
6 files changed, 31 insertions, 30 deletions
diff --git a/docs/admin/engines/engine_settings.rst b/docs/admin/engines/configured_engines.rst
index 9ca5620e2..af20e5611 100644
--- a/docs/admin/engines/engine_settings.rst
+++ b/docs/admin/engines/configured_engines.rst
@@ -1,8 +1,8 @@
-.. _general engine settings:
+.. _configured engines:
-=======================
-General Engine Settings
-=======================
+==================
+Configured Engines
+==================
.. sidebar:: Further reading ..
@@ -12,27 +12,28 @@ General Engine Settings
Explanation of the :ref:`general engine configuration` shown in the table
:ref:`configured engines`.
-============= =========== ==================== ============
-:ref:`engine settings` :ref:`engine file`
-------------------------- ---------------------------------
-Name (cfg) Categories
-------------------------- ---------------------------------
-Engine .. Paging support **P**
-------------------------- -------------------- ------------
-Shortcut **S** Language support **L**
-Timeout **TO** Time range support **TR**
-Disabled **D** Engine type **ET**
-------------- ----------- -------------------- ------------
-Safe search **SS**
-------------- ----------- ---------------------------------
-Weigth **W**
-------------- ----------- ---------------------------------
-Disabled **D**
-------------- ----------- ---------------------------------
-Show errors **DE**
-============= =========== =================================
+.. table:: The legend for the following table
+ :width: 100%
-.. _configured engines:
+ ============= =========== ==================== ============
+ :ref:`engine settings` :ref:`engine file`
+ ------------------------- ---------------------------------
+ Name (cfg) .. Categories
+ ------------- ----------- -------------------- ------------
+ Engine .. Paging support **P**
+ ------------- ----------- -------------------- ------------
+ Shortcut **S** Language support **L**
+ Timeout **TO** Time range support **TR**
+ Disabled **D** Engine type **ET**
+ ------------- ----------- -------------------- ------------
+ Safe search **SS**
+ ------------- ----------- ---------------------------------
+ Weigth **W**
+ ------------- ----------- ---------------------------------
+ Disabled **D**
+ ------------- ----------- ---------------------------------
+ Show errors **DE**
+ ============= =========== =================================
.. jinja:: searx
diff --git a/docs/admin/engines/index.rst b/docs/admin/engines/index.rst
index 02d6e604b..2be4d0e08 100644
--- a/docs/admin/engines/index.rst
+++ b/docs/admin/engines/index.rst
@@ -12,7 +12,7 @@ Engines & Settings
.. toctree::
:maxdepth: 1
- engine_settings
+ configured_engines
private-engines
recoll
sql-engines
diff --git a/docs/admin/settings.rst b/docs/admin/settings.rst
index fd99d9587..1fe083a97 100644
--- a/docs/admin/settings.rst
+++ b/docs/admin/settings.rst
@@ -236,7 +236,7 @@ Engine settings
.. sidebar:: Further reading ..
- - :ref:`general engine settings`
+ - :ref:`configured engines`
- :ref:`engines-dev`
In the code example below a *full fledged* example of a YAML setup from a dummy
diff --git a/docs/dev/engine_overview.rst b/docs/dev/engine_overview.rst
index cad92ecb1..d79f662b8 100644
--- a/docs/dev/engine_overview.rst
+++ b/docs/dev/engine_overview.rst
@@ -8,7 +8,7 @@ Engine Overview
.. sidebar:: Further reading ..
- - :ref:`general engine settings`
+ - :ref:`configured engines`
- :ref:`settings engine`
.. contents::
diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst
index 252120925..230c92a78 100644
--- a/docs/dev/reST.rst
+++ b/docs/dev/reST.rst
@@ -1281,10 +1281,10 @@ Templating
Templating is suitable for documentation which is created generic at the build
time. The sphinx-jinja_ extension evaluates jinja_ templates in the :ref:`make
install` (with searx modules installed). We use this e.g. to build chapter:
-:ref:`general engine settings`. Below the jinja directive from the
+:ref:`configured engines`. Below the jinja directive from the
:origin:`docs/admin/engines.rst` is shown:
-.. literalinclude:: ../admin/engines/engine_settings.rst
+.. literalinclude:: ../admin/engines/configured_engines.rst
:language: reST
:start-after: .. _configured engines:
diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst
index 76bc01623..5fcdc4560 100644
--- a/docs/dev/search_api.rst
+++ b/docs/dev/search_api.rst
@@ -20,7 +20,7 @@ Parameters
- :ref:`engines-dev`
- :ref:`settings.yml`
- - :ref:`general engine settings`
+ - :ref:`configured engines`
``q`` : required
The search query. This string is passed to external search services. Thus,