diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2021-06-01 14:36:02 +0200 |
|---|---|---|
| committer | Alexandre Flament <alex@al-f.net> | 2021-06-01 16:37:20 +0200 |
| commit | ebbd5f73666c1e6c73f0e4f0a575461ccb3a7a42 (patch) | |
| tree | 1e5f48e347de7b34a9cfa285c46cee8e4c3b0f10 /docs | |
| parent | 8375974dff24623d8cb2790ca66ffb067ea34484 (diff) | |
| download | searxng-ebbd5f73666c1e6c73f0e4f0a575461ccb3a7a42.tar.gz searxng-ebbd5f73666c1e6c73f0e4f0a575461ccb3a7a42.zip | |
[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 <markus.heiser@darmarit.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/index.rst | 1 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/src/index.rst | 14 | ||||
| -rw-r--r-- | docs/src/searx.engines.rst | 8 | ||||
| -rw-r--r-- | docs/src/searx.engines.xpath.rst (renamed from docs/dev/xpath_engine.rst) | 0 |
5 files changed, 23 insertions, 1 deletions
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 index 4c73763d1..4c73763d1 100644 --- a/docs/dev/xpath_engine.rst +++ b/docs/src/searx.engines.xpath.rst |