From d965c634297fc1b6010e45b2050422611d06193b Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 3 Jun 2021 14:54:20 +0200 Subject: [docs] reorder chapter "Engines & Settings" - Split chapter "Engines" and rename it into "Engines & Settings" - Move docs/admin/engines.rst -> docs/admin/engines/engine_settings.rst Signed-off-by: Markus Heiser --- docs/admin/engines.rst | 91 ---------------------------------- docs/admin/engines/engine_settings.rst | 76 ++++++++++++++++++++++++++++ docs/admin/engines/index.rst | 21 ++++++++ docs/admin/index.rst | 2 +- docs/admin/settings.rst | 1 + 5 files changed, 99 insertions(+), 92 deletions(-) delete mode 100644 docs/admin/engines.rst create mode 100644 docs/admin/engines/engine_settings.rst create mode 100644 docs/admin/engines/index.rst (limited to 'docs/admin') diff --git a/docs/admin/engines.rst b/docs/admin/engines.rst deleted file mode 100644 index 87613f1ee..000000000 --- a/docs/admin/engines.rst +++ /dev/null @@ -1,91 +0,0 @@ -======= -Engines -======= - -Special Engine Settings -======================= - -.. sidebar:: Further reading .. - - - :ref:`settings engine` - - :ref:`engine settings` & :ref:`engine file` - -.. toctree:: - :maxdepth: 1 - - engines/recoll - engines/sql-engines - engines/command-line-engines - engines/searx.engines.xpath - - -.. _engines generic: - -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** -============= =========== ================================= - -.. _configured engines: - -.. jinja:: searx - - .. flat-table:: Engines configured at built time (defaults) - :header-rows: 1 - :stub-columns: 2 - - * - Name (cfg) - - S - - Engine - - TO - - Categories - - P - - L - - SS - - D - - TR - - ET - - W - - D - - DE - - {% for name, mod in engines.items() %} - - * - {{name}} - - !{{mod.shortcut}} - - {{mod.__name__}} - - {{mod.timeout}} - - {{", ".join(mod.categories)}} - - {{(mod.paging and "y") or ""}} - - {{(mod.language_support and "y") or ""}} - - {{(mod.safesearch and "y") or ""}} - - {{(mod.disabled and "y") or ""}} - - {{(mod.time_range_support and "y") or ""}} - - {{mod.engine_type or ""}} - - {{mod.weight or 1 }} - - {{(mod.disabled and "y") or ""}} - - {{(mod.display_error_messages and "y") or ""}} - - {% endfor %} - diff --git a/docs/admin/engines/engine_settings.rst b/docs/admin/engines/engine_settings.rst new file mode 100644 index 000000000..9ca5620e2 --- /dev/null +++ b/docs/admin/engines/engine_settings.rst @@ -0,0 +1,76 @@ +.. _general engine settings: + +======================= +General Engine Settings +======================= + +.. sidebar:: Further reading .. + + - :ref:`engines-dev` + - :ref:`settings engine` + +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** +============= =========== ================================= + +.. _configured engines: + +.. jinja:: searx + + .. flat-table:: Engines configured at built time (defaults) + :header-rows: 1 + :stub-columns: 2 + + * - Name (cfg) + - S + - Engine + - TO + - Categories + - P + - L + - SS + - D + - TR + - ET + - W + - D + - DE + + {% for name, mod in engines.items() %} + + * - {{name}} + - !{{mod.shortcut}} + - {{mod.__name__}} + - {{mod.timeout}} + - {{", ".join(mod.categories)}} + - {{(mod.paging and "y") or ""}} + - {{(mod.language_support and "y") or ""}} + - {{(mod.safesearch and "y") or ""}} + - {{(mod.disabled and "y") or ""}} + - {{(mod.time_range_support and "y") or ""}} + - {{mod.engine_type or ""}} + - {{mod.weight or 1 }} + - {{(mod.disabled and "y") or ""}} + - {{(mod.display_error_messages and "y") or ""}} + + {% endfor %} + diff --git a/docs/admin/engines/index.rst b/docs/admin/engines/index.rst new file mode 100644 index 000000000..923b20a2b --- /dev/null +++ b/docs/admin/engines/index.rst @@ -0,0 +1,21 @@ +.. _engines and settings: + +================== +Engines & Settings +================== + +.. sidebar:: Further reading .. + + - :ref:`settings engine` + - :ref:`engine settings` & :ref:`engine file` + +.. toctree:: + :maxdepth: 1 + + engine_settings + recoll + sql-engines + command-line-engines + searx.engines.xpath + + diff --git a/docs/admin/index.rst b/docs/admin/index.rst index c708c4ffa..9be5b6a37 100644 --- a/docs/admin/index.rst +++ b/docs/admin/index.rst @@ -14,10 +14,10 @@ Administrator documentation installation-docker update-searx settings + engines/index api architecture filtron morty - engines plugins buildhosts diff --git a/docs/admin/settings.rst b/docs/admin/settings.rst index d0773467d..3baa83365 100644 --- a/docs/admin/settings.rst +++ b/docs/admin/settings.rst @@ -229,6 +229,7 @@ Engine settings .. sidebar:: Further reading .. + - :ref:`general engine settings` - :ref:`engines-dev` .. code:: yaml -- cgit v1.2.3