summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/admin/settings/settings_search.rst3
-rw-r--r--docs/conf.py1
-rw-r--r--docs/src/searx.favicons.rst48
3 files changed, 51 insertions, 1 deletions
diff --git a/docs/admin/settings/settings_search.rst b/docs/admin/settings/settings_search.rst
index eb63ab684..860a94af9 100644
--- a/docs/admin/settings/settings_search.rst
+++ b/docs/admin/settings/settings_search.rst
@@ -43,7 +43,8 @@
- ``wikipedia``
``favicon_resolver``:
- Favicon resolver, leave blank to turn off the feature by default.
+ :ref:`Favicon resolver <favicons>`, leave blank to turn off the feature by
+ default.
- ``allesedv``
- ``duckduckgo``
diff --git a/docs/conf.py b/docs/conf.py
index fec9eb64b..27881a4e0 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -127,6 +127,7 @@ extensions = [
"sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs
'myst_parser', # https://www.sphinx-doc.org/en/master/usage/markdown.html
'notfound.extension', # https://github.com/readthedocs/sphinx-notfound-page
+ 'sphinxcontrib.autodoc_pydantic', # https://github.com/mansenfranzen/autodoc_pydantic
]
autodoc_default_options = {
diff --git a/docs/src/searx.favicons.rst b/docs/src/searx.favicons.rst
new file mode 100644
index 000000000..6b98d5b8e
--- /dev/null
+++ b/docs/src/searx.favicons.rst
@@ -0,0 +1,48 @@
+.. _favicons:
+
+========
+Favicons
+========
+
+.. contents::
+ :depth: 2
+ :local:
+ :backlinks: entry
+
+.. automodule:: searx.favicons
+ :members:
+
+.. _favicons.config:
+
+Favicons Config
+===============
+
+.. automodule:: searx.favicons.config
+ :members:
+
+.. _favicons.proxy:
+
+Favicons Proxy
+==============
+
+.. automodule:: searx.favicons.proxy
+ :members:
+
+.. _favicons.resolver:
+
+Favicons Resolver
+=================
+
+.. automodule:: searx.favicons.resolvers
+ :members:
+
+.. _favicons.cache:
+
+Favicons Cache
+==============
+
+.. automodule:: searx.favicons.cache
+ :members:
+
+
+