diff options
| author | Alexandre Flament <alex@al-f.net> | 2021-06-01 16:40:38 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-01 16:40:38 +0200 |
| commit | ee83c99d2b40efaaf4f3e6635e7a43f7731cb128 (patch) | |
| tree | 331492af5f7b8435037d984c102de07727abd56a /docs/src | |
| parent | e3f4a7731180b87ba2b3acbe4e1ea8070624001f (diff) | |
| parent | 15de8708b706d5fe7e77febffd580449d827b938 (diff) | |
Merge pull request #116 from searxng/minor-refactoring-searx-engines
[mod] searx.engines.__init__: refactoring
Diffstat (limited to 'docs/src')
| -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 | 9 |
3 files changed, 31 insertions, 0 deletions
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: + |