Browse Source

[docs] move blog article "SQL engines" to admin/engines/

The article "SQL engines" should be in admin's engine documentation (like the
recoll engine).

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Markus Heiser 3 years ago
parent
commit
1b3f0c848e
3 changed files with 21 additions and 12 deletions
  1. 1 0
      docs/admin/engines.rst
  2. 20 11
      docs/admin/engines/sql-engines.rst
  3. 0 1
      docs/blog/index.rst

+ 1 - 0
docs/admin/engines.rst

@@ -14,6 +14,7 @@ Special Engine Settings
    :maxdepth: 1
 
    engines/recoll
+   engines/sql-engines
    engines/command-line-engines
 
 

+ 20 - 11
docs/blog/sql-engines.rst → docs/admin/engines/sql-engines.rst

@@ -1,5 +1,7 @@
+.. _sql engines:
+
 ===========
-SQL engines
+SQL Engines
 ===========
 
 .. sidebar:: further read
@@ -36,9 +38,10 @@ place the templates at::
 
   searx/templates/{theme_name}/result_templates/{template_name}
 
-As mentioned in previous blog posts, if you do not wish to expose these engines
-on a public instance, you can still add them and limit the access by setting
-``tokens`` as described in section :ref:`private engines`.
+If you do not wish to expose these engines on a public instance, you can still
+add them and limit the access by setting ``tokens`` as described in section
+:ref:`private engines`.
+
 
 Configure the engines
 =====================
@@ -58,6 +61,10 @@ returned results use the option ``limit``.
 SQLite
 ------
 
+.. sidebar:: info
+
+   - :origin:`sqlite.py <searx/engines/sqlite.py>`
+
 .. _MediathekView: https://mediathekview.de/
 
 SQLite is a small, fast and reliable SQL database engine.  It does not require
@@ -106,9 +113,10 @@ PostgreSQL
 
 .. _psycopg2: https://www.psycopg.org/install
 
-.. sidebar:: requirements
+.. sidebar:: info
 
-   ``pip install`` psycopg2_
+   - :origin:`postgresql.py <searx/engines/postgresql.py>`
+   - ``pip install`` psycopg2_
 
 PostgreSQL is a powerful and robust open source database.  Before configuring
 the PostgreSQL engine, you must install the dependency ``psychopg2``.  You can
@@ -130,9 +138,10 @@ MySQL
 
 .. _mysql-connector-python: https://pypi.org/project/mysql-connector-python
 
-.. sidebar:: requirements
+.. sidebar:: info
 
-   ``pip install`` mysql-connector-python_
+   - :origin:`mysql_server.py <searx/engines/mysql_server.py>`
+   - ``pip install`` mysql-connector-python_
 
 MySQL is said to be the most popular open source database. Before enabling MySQL
 engine, you must install the package ``mysql-connector-python``.
@@ -152,9 +161,9 @@ example configuration for quering a MySQL server:
      query_str: 'SELECT * from my_table WHERE my_column=%(query)s'
 
 
-Acknowledgement
-===============
+Acknowledgment
+==============
 
 This development was sponsored by `Search and Discovery Fund
-<https://nlnet.nl/discovery>`_ of `NLnet Foundation <https://nlnet.nl/>`_ .
+<https://nlnet.nl/discovery>`_ of `NLnet Foundation <https://nlnet.nl/>`_.
 

+ 0 - 1
docs/blog/index.rst

@@ -11,4 +11,3 @@ Blog
    intro-offline
    private-engines
    search-indexer-engines
-   sql-engines