From ebbd5f73666c1e6c73f0e4f0a575461ccb3a7a42 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 1 Jun 2021 14:36:02 +0200 Subject: [PATCH] [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/dev/index.rst | 1 - docs/index.rst | 1 + docs/src/index.rst | 14 ++++++++++++++ docs/src/searx.engines.rst | 8 ++++++++ .../searx.engines.xpath.rst} | 0 5 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 docs/src/index.rst create mode 100644 docs/src/searx.engines.rst rename docs/{dev/xpath_engine.rst => src/searx.engines.xpath.rst} (100%) diff --git a/docs/dev/index.rst b/docs/dev/index.rst index 82e5d3e84..ba0a25a9c 100644 --- a/docs/dev/index.rst +++ b/docs/dev/index.rst @@ -9,7 +9,6 @@ Developer documentation quickstart contribution_guide engine_overview - xpath_engine search_api plugins translation diff --git a/docs/index.rst b/docs/index.rst index 40105129f..71f0d8855 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -35,5 +35,6 @@ anyone, you can set up your own, see :ref:`installation`. searx_extra/index utils/index blog/index + src/index .. _Searx-instances: https://searx.space 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/dev/xpath_engine.rst b/docs/src/searx.engines.xpath.rst similarity index 100% rename from docs/dev/xpath_engine.rst rename to docs/src/searx.engines.xpath.rst