diff options
| author | Markus Heiser <markus.heiser@darmarIT.de> | 2021-05-23 10:02:16 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-23 10:02:16 +0000 |
| commit | 703f8c4a8b4bd00a4070163cb14d1fe73e234d75 (patch) | |
| tree | b25504c059e2bb4e114f4b444cdd48daf12afd2b /docs | |
| parent | 2398e9a1fea6c5c8c2822766d5b0ba38031aec2e (diff) | |
| parent | 2065a324d9ac53ca8ede30ce9746ed92bb3d5db0 (diff) | |
Merge pull request #91 from return42/xpath-misc
[doc] add documentation about the XPath engine
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/engine_overview.rst | 6 | ||||
| -rw-r--r-- | docs/dev/index.rst | 1 | ||||
| -rw-r--r-- | docs/dev/xpath_engine.rst | 9 | ||||
| -rw-r--r-- | docs/index.rst | 3 |
4 files changed, 17 insertions, 2 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: + diff --git a/docs/index.rst b/docs/index.rst index 862106ebe..40105129f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,8 @@ Welcome to searxng *Search without being tracked.* -.. warning:: +.. hint:: + This is not searx, but searxng. Searxng is a free internet metasearch engine which aggregates results from more |