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 | |
| 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')
| -rw-r--r-- | docs/conf.py | 9 | ||||
| -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 |
6 files changed, 31 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 998b07ff1..11e980909 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,7 +13,14 @@ project = u'searx' copyright = u'2015-2020, Adam Tauber, Noémi Ványi' author = u'Adam Tauber' release, version = VERSION_STRING, VERSION_STRING -highlight_language = 'none' + +# hint: sphinx.ext.viewcode won't highlight when 'highlight_language' [1] is set +# to string 'none' [2] +# +# [1] https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html +# [2] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-highlight_language + +highlight_language = 'default' # General -------------------------------------------------------------- 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 |