From d965c634297fc1b6010e45b2050422611d06193b Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 3 Jun 2021 14:54:20 +0200 Subject: [PATCH] [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 --- .../engine_settings.rst} | 23 ++++--------------- docs/admin/engines/index.rst | 21 +++++++++++++++++ docs/admin/index.rst | 2 +- docs/admin/settings.rst | 1 + docs/dev/reST.rst | 4 ++-- docs/dev/search_api.rst | 2 +- 6 files changed, 30 insertions(+), 23 deletions(-) rename docs/admin/{engines.rst => engines/engine_settings.rst} (89%) create mode 100644 docs/admin/engines/index.rst diff --git a/docs/admin/engines.rst b/docs/admin/engines/engine_settings.rst similarity index 89% rename from docs/admin/engines.rst rename to docs/admin/engines/engine_settings.rst index 87613f1ee..9ca5620e2 100644 --- a/docs/admin/engines.rst +++ b/docs/admin/engines/engine_settings.rst @@ -1,28 +1,13 @@ -======= -Engines -======= +.. _general engine settings: -Special Engine Settings +======================= +General Engine Settings ======================= .. sidebar:: Further reading .. + - :ref:`engines-dev` - :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`. 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 diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index 181d9829d..252120925 100644 --- a/docs/dev/reST.rst +++ b/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:`engines generic`. Below the jinja directive from the +:ref:`general engine settings`. Below the jinja directive from the :origin:`docs/admin/engines.rst` is shown: -.. literalinclude:: ../admin/engines.rst +.. literalinclude:: ../admin/engines/engine_settings.rst :language: reST :start-after: .. _configured engines: diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst index 68fee94bf..76bc01623 100644 --- a/docs/dev/search_api.rst +++ b/docs/dev/search_api.rst @@ -20,7 +20,7 @@ Parameters - :ref:`engines-dev` - :ref:`settings.yml` - - :ref:`engines generic` + - :ref:`general engine settings` ``q`` : required The search query. This string is passed to external search services. Thus,