Browse Source

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

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Markus Heiser 3 years ago
parent
commit
340d25b19b

+ 25 - 24
docs/admin/engines/engine_settings.rst → 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
 

+ 1 - 1
docs/admin/engines/index.rst

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

+ 1 - 1
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

+ 1 - 1
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::

+ 2 - 2
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:
 

+ 1 - 1
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,