[docs] rename 'General Engine Settings' to 'Configured Engines'

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2021-06-04 11:29:58 +02:00
parent c647c8b7a5
commit 340d25b19b
6 changed files with 31 additions and 30 deletions

View file

@ -1,8 +1,8 @@
.. _general engine settings: .. _configured engines:
======================= ==================
General Engine Settings Configured Engines
======================= ==================
.. sidebar:: Further reading .. .. sidebar:: Further reading ..
@ -12,27 +12,28 @@ General Engine Settings
Explanation of the :ref:`general engine configuration` shown in the table Explanation of the :ref:`general engine configuration` shown in the table
:ref:`configured engines`. :ref:`configured engines`.
============= =========== ==================== ============ .. table:: The legend for the following table
:ref:`engine settings` :ref:`engine file` :width: 100%
------------------------- ---------------------------------
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**
============= =========== =================================
.. _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 .. jinja:: searx

View file

@ -12,7 +12,7 @@ Engines & Settings
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
engine_settings configured_engines
private-engines private-engines
recoll recoll
sql-engines sql-engines

View file

@ -236,7 +236,7 @@ Engine settings
.. sidebar:: Further reading .. .. sidebar:: Further reading ..
- :ref:`general engine settings` - :ref:`configured engines`
- :ref:`engines-dev` - :ref:`engines-dev`
In the code example below a *full fledged* example of a YAML setup from a dummy In the code example below a *full fledged* example of a YAML setup from a dummy

View file

@ -8,7 +8,7 @@ Engine Overview
.. sidebar:: Further reading .. .. sidebar:: Further reading ..
- :ref:`general engine settings` - :ref:`configured engines`
- :ref:`settings engine` - :ref:`settings engine`
.. contents:: .. contents::

View file

@ -1281,10 +1281,10 @@ Templating
Templating is suitable for documentation which is created generic at the build Templating is suitable for documentation which is created generic at the build
time. The sphinx-jinja_ extension evaluates jinja_ templates in the :ref:`make 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: 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: :origin:`docs/admin/engines.rst` is shown:
.. literalinclude:: ../admin/engines/engine_settings.rst .. literalinclude:: ../admin/engines/configured_engines.rst
:language: reST :language: reST
:start-after: .. _configured engines: :start-after: .. _configured engines:

View file

@ -20,7 +20,7 @@ Parameters
- :ref:`engines-dev` - :ref:`engines-dev`
- :ref:`settings.yml` - :ref:`settings.yml`
- :ref:`general engine settings` - :ref:`configured engines`
``q`` : required ``q`` : required
The search query. This string is passed to external search services. Thus, The search query. This string is passed to external search services. Thus,