[doc] add documentation about the XPath engine

- pylint searx/engines/xpath.py
- fix indentation of some long lines
- add logging
- add doc-strings

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

3 files changed, 15 insertions, 1 deletions

diff --git a/docs/dev/engine_overview.rst b/docs/dev/engine_overview.rst
index 42c205d9d..2a661ec40 100644
--- a/docs/dev/engine_overview.rst
+++ b/docs/dev/engine_overview.rst
@@ -43,7 +43,7 @@ argument                type        information
 categories              list        pages, in which the engine is working
 paging                  boolean     support multible pages
 time_range_support      boolean     support search time range
-engine_type             str         ``online`` by default, other possibles values are 
+engine_type             str         ``online`` by default, other possibles values are
                                     ``offline``, ``online_dictionnary``, ``online_currency``
 ======================= =========== ========================================================
 
@@ -100,6 +100,8 @@ example code
    paging = True
 
 
+.. _engine request:
+
 making a request
 ================
 
@@ -198,6 +200,8 @@ example code
        return params
 
 
+.. _engine results:
+
 returned results
 ================
 
diff --git a/docs/dev/index.rst b/docs/dev/index.rst
index ba0a25a9c..82e5d3e84 100644
--- a/docs/dev/index.rst
+++ b/docs/dev/index.rst
@@ -9,6 +9,7 @@ Developer documentation
    quickstart
    contribution_guide
    engine_overview
+   xpath_engine
    search_api
    plugins
    translation
diff --git a/docs/dev/xpath_engine.rst b/docs/dev/xpath_engine.rst
new file mode 100644
index 000000000..4c73763d1
--- /dev/null
+++ b/docs/dev/xpath_engine.rst
@@ -0,0 +1,9 @@
+.. _xpath_engine:
+
+================
+The XPath engine
+================
+
+.. automodule:: searx.engines.xpath
+  :members:
+