From ebbd5f73666c1e6c73f0e4f0a575461ccb3a7a42 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 1 Jun 2021 14:36:02 +0200 Subject: [docs] add new rubric 'Source-Code' - document namespace: searx.engines - move docs/dev/xpath_engine.rst -> docs/src/searx.engines.xpath.rst Signed-off-by: Markus Heiser --- docs/src/index.rst | 14 ++++++++++++++ docs/src/searx.engines.rst | 8 ++++++++ docs/src/searx.engines.xpath.rst | 9 +++++++++ 3 files changed, 31 insertions(+) create mode 100644 docs/src/index.rst create mode 100644 docs/src/searx.engines.rst create mode 100644 docs/src/searx.engines.xpath.rst (limited to 'docs/src') diff --git a/docs/src/index.rst b/docs/src/index.rst new file mode 100644 index 000000000..f88b943d5 --- /dev/null +++ b/docs/src/index.rst @@ -0,0 +1,14 @@ +=========== +Source-Code +=========== + +This is a partial documentation of our source code. We are not aim to document +every item from the source code, but we will add documentation when requested. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents + :glob: + + searx.* diff --git a/docs/src/searx.engines.rst b/docs/src/searx.engines.rst new file mode 100644 index 000000000..687fdb0b2 --- /dev/null +++ b/docs/src/searx.engines.rst @@ -0,0 +1,8 @@ +.. _load_engines: + +============ +Load Engines +============ + +.. automodule:: searx.engines + :members: diff --git a/docs/src/searx.engines.xpath.rst b/docs/src/searx.engines.xpath.rst new file mode 100644 index 000000000..4c73763d1 --- /dev/null +++ b/docs/src/searx.engines.xpath.rst @@ -0,0 +1,9 @@ +.. _xpath_engine: + +================ +The XPath engine +================ + +.. automodule:: searx.engines.xpath + :members: + -- cgit v1.2.3