summaryrefslogtreecommitdiff
path: root/docs/user
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/user
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/user')
-rw-r--r--docs/user/about.rst4
-rw-r--r--docs/user/configured_engines.rst89
-rw-r--r--docs/user/index.rst10
-rw-r--r--docs/user/search-syntax.rst4
4 files changed, 102 insertions, 5 deletions
diff --git a/docs/user/about.rst b/docs/user/about.rst
new file mode 100644
index 000000000..08f1a068e
--- /dev/null
+++ b/docs/user/about.rst
@@ -0,0 +1,4 @@
+.. _about SearXNG:
+
+.. include:: about.md
+ :parser: myst_parser.sphinx_
diff --git a/docs/user/configured_engines.rst b/docs/user/configured_engines.rst
new file mode 100644
index 000000000..9507c77df
--- /dev/null
+++ b/docs/user/configured_engines.rst
@@ -0,0 +1,89 @@
+.. _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/user/index.rst b/docs/user/index.rst
index af2051f01..4603b4716 100644
--- a/docs/user/index.rst
+++ b/docs/user/index.rst
@@ -7,9 +7,9 @@ User information
:local:
:backlinks: entry
+.. toctree::
+ :maxdepth: 2
-.. _search-syntax:
-
-.. include:: search-syntax.md
- :parser: myst_parser.sphinx_
-
+ search-syntax
+ configured_engines
+ about
diff --git a/docs/user/search-syntax.rst b/docs/user/search-syntax.rst
new file mode 100644
index 000000000..3acddd6e3
--- /dev/null
+++ b/docs/user/search-syntax.rst
@@ -0,0 +1,4 @@
+.. _search-syntax:
+
+.. include:: search-syntax.md
+ :parser: myst_parser.sphinx_