forked from Ponysearch/Ponysearch
[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 <markus.heiser@darmarit.de>
This commit is contained in:
parent
0d31740cfd
commit
d965c63429
6 changed files with 30 additions and 23 deletions
|
@ -1,28 +1,13 @@
|
||||||
=======
|
.. _general engine settings:
|
||||||
Engines
|
|
||||||
=======
|
|
||||||
|
|
||||||
Special Engine Settings
|
=======================
|
||||||
|
General Engine Settings
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
.. sidebar:: Further reading ..
|
.. sidebar:: Further reading ..
|
||||||
|
|
||||||
|
- :ref:`engines-dev`
|
||||||
- :ref:`settings engine`
|
- :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
|
Explanation of the :ref:`general engine configuration` shown in the table
|
||||||
:ref:`configured engines`.
|
:ref:`configured engines`.
|
21
docs/admin/engines/index.rst
Normal file
21
docs/admin/engines/index.rst
Normal file
|
@ -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
|
||||||
|
|
||||||
|
|
|
@ -14,10 +14,10 @@ Administrator documentation
|
||||||
installation-docker
|
installation-docker
|
||||||
update-searx
|
update-searx
|
||||||
settings
|
settings
|
||||||
|
engines/index
|
||||||
api
|
api
|
||||||
architecture
|
architecture
|
||||||
filtron
|
filtron
|
||||||
morty
|
morty
|
||||||
engines
|
|
||||||
plugins
|
plugins
|
||||||
buildhosts
|
buildhosts
|
||||||
|
|
|
@ -229,6 +229,7 @@ Engine settings
|
||||||
|
|
||||||
.. sidebar:: Further reading ..
|
.. sidebar:: Further reading ..
|
||||||
|
|
||||||
|
- :ref:`general engine settings`
|
||||||
- :ref:`engines-dev`
|
- :ref:`engines-dev`
|
||||||
|
|
||||||
.. code:: yaml
|
.. code:: yaml
|
||||||
|
|
|
@ -1281,10 +1281,10 @@ Templating
|
||||||
Templating is suitable for documentation which is created generic at the build
|
Templating is suitable for documentation which is created generic at the build
|
||||||
time. The sphinx-jinja_ extension evaluates jinja_ templates in the :ref:`make
|
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:
|
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:
|
:origin:`docs/admin/engines.rst` is shown:
|
||||||
|
|
||||||
.. literalinclude:: ../admin/engines.rst
|
.. literalinclude:: ../admin/engines/engine_settings.rst
|
||||||
:language: reST
|
:language: reST
|
||||||
:start-after: .. _configured engines:
|
:start-after: .. _configured engines:
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@ Parameters
|
||||||
|
|
||||||
- :ref:`engines-dev`
|
- :ref:`engines-dev`
|
||||||
- :ref:`settings.yml`
|
- :ref:`settings.yml`
|
||||||
- :ref:`engines generic`
|
- :ref:`general engine settings`
|
||||||
|
|
||||||
``q`` : required
|
``q`` : required
|
||||||
The search query. This string is passed to external search services. Thus,
|
The search query. This string is passed to external search services. Thus,
|
||||||
|
|
Loading…
Reference in a new issue