summaryrefslogtreecommitdiff
path: root/docs/admin
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2023-04-16 14:23:27 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2023-04-16 15:21:26 +0200
commita5dad3b7c83ce59f30494cdb3fa8f129b690fca2 (patch)
tree146fa9279acab4c4d8b03ccb1845d9c1c1c7f24c /docs/admin
parent3e18aa6fbf9d49fb5edc81b7260057f43981e0c0 (diff)
downloadsearxng-a5dad3b7c83ce59f30494cdb3fa8f129b690fca2.tar.gz
searxng-a5dad3b7c83ce59f30494cdb3fa8f129b690fca2.zip
[doc] slightly reorder the chapters & improve TOCs for better navigation
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin')
-rw-r--r--docs/admin/engines/configured_engines.rst89
-rw-r--r--docs/admin/engines/index.rst7
2 files changed, 5 insertions, 91 deletions
diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst
deleted file mode 100644
index 9507c77df..000000000
--- a/docs/admin/engines/configured_engines.rst
+++ /dev/null
@@ -1,89 +0,0 @@
-.. _configured engines:
-
-==================
-Configured Engines
-==================
-
-.. sidebar:: Further reading ..
-
- - :ref:`settings categories_as_tabs`
- - :ref:`engines-dev`
- - :ref:`settings engine`
- - :ref:`general engine configuration`
-
-.. jinja:: searx
-
- SearXNG supports {{engines | length}} search engines of which
- {{enabled_engine_count}} are enabled by default.
-
- Engines can be assigned to multiple :ref:`categories <engine categories>`.
- The UI displays the tabs that are configured in :ref:`categories_as_tabs
- <settings categories_as_tabs>`. In addition to these UI categories (also
- called *tabs*), engines can be queried by their name or the categories they
- belong to, by using a :ref:`\!bing syntax <search-syntax>`.
-
-.. contents:: Contents
- :depth: 2
- :local:
- :backlinks: entry
-
-.. jinja:: searx
-
- {% for category, engines in categories_as_tabs.items() %}
-
- tab ``!{{category.replace(' ', '_')}}``
- ---------------------------------------
-
- {% for group, group_bang, engines in engines | group_engines_in_tab %}
-
- {% if loop.length > 1 %}
- {% if group_bang %}group ``{{group_bang}}``{% else %}{{group}}{% endif %}
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- {% endif %}
-
- .. flat-table::
- :header-rows: 2
- :stub-columns: 1
- :widths: 10 1 10 1 1 1 1 1 1 1
-
- * - :cspan:`5` Engines configured by default (in :ref:`settings.yml <engine settings>`)
- - :cspan:`3` :ref:`Supported features <engine file>`
-
- * - Name
- - !bang
- - Module
- - Disabled
- - Timeout
- - Weight
- - Paging
- - Locale
- - Safe search
- - Time range
-
- {% for mod in engines %}
-
- * - `{{mod.name}} <{{mod.about and mod.about.website}}>`_
- {%- if mod.about and mod.about.language %}
- ({{mod.about.language | upper}})
- {%- endif %}
- - ``!{{mod.shortcut}}``
- - {%- if 'searx.engines.' + mod.__name__ in documented_modules %}
- :py:mod:`~searx.engines.{{mod.__name__}}`
- {%- else %}
- :origin:`{{mod.__name__}} <searx/engines/{{mod.__name__}}.py>`
- {%- endif %}
- - {{(mod.disabled and "y") or ""}}
- - {{mod.timeout}}
- - {{mod.weight or 1 }}
- {% if mod.engine_type == 'online' %}
- - {{(mod.paging and "y") or ""}}
- - {{(mod.language_support and "y") or ""}}
- - {{(mod.safesearch and "y") or ""}}
- - {{(mod.time_range_support and "y") or ""}}
- {% else %}
- - :cspan:`3` not applicable ({{mod.engine_type}})
- {% endif %}
-
- {% endfor %}
- {% endfor %}
- {% endfor %}
diff --git a/docs/admin/engines/index.rst b/docs/admin/engines/index.rst
index f488731ea..92c723817 100644
--- a/docs/admin/engines/index.rst
+++ b/docs/admin/engines/index.rst
@@ -10,10 +10,13 @@ Engines & Settings
- :ref:`engine settings` & :ref:`engine file`
.. toctree::
- :maxdepth: 1
+ :maxdepth: 3
settings
- configured_engines
+
+.. toctree::
+ :maxdepth: 1
+
private-engines
recoll
sql-engines