[furo] add some project links to the online documentation (#3408)

- add button for editing docs source on GitHub
- add links to GitHub repository and public instances (searx.space)

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

docs/_static/searxng.css

@@ -0,0 +1,57 @@
+.content {
+  width: 52em;    /*  instead of 46em */
+}
+
+p code.literal {
+  text-wrap: nowrap;
+}
+
+aside.sidebar {
+  border-color: lightsteelblue;
+  border-radius: 3pt;
+}
+
+p.sidebar-title, .sidebar p {
+  margin: 6pt;
+}
+
+.sidebar li,
+.hlist li {
+  list-style-type: disclosure-closed;
+}
+
+.sphinxsidebar .current > a {
+  font-weight: bold;
+}
+
+/* admonitions with (rendered) reST markup examples (:class: rst-example)
+ *
+ * .. admonition:: title of the example
+ *     :class: rst-example
+ *     ....
+*/
+
+div.rst-example {
+  background-color: inherit;
+  margin: 0;
+  border-top: none;
+  border-right: 1px solid #ccc;
+  border-bottom: none;
+  border-left: none;
+  border-radius: none;
+  padding: 0;
+}
+
+div.rst-example > p.admonition-title {
+  font-family: Sans Serif;
+  font-style: italic;
+  font-size: 0.8em;
+  display: block;
+  border-bottom: 1px solid #ccc;
+  padding: 0.5em 1em;
+  text-align: right;
+}
+
+div.sphinx-tabs {
+    clear: both;
+}

docs/_themes/searxng/static/searxng.css

@@ -1,151 +0,0 @@
-@import url("pocoo.css");
-
-a, a.reference, a.footnote-reference {
-  color: #004b6b;
-  border-color: #004b6b;
-}
-
-a:hover {
-  color: #6d4100;
-  border-color: #6d4100;
-}
-
-p.version-warning {
-  background-color: #004b6b;
-}
-
-aside.sidebar {
-  background-color: whitesmoke;
-  border-color: lightsteelblue;
-  border-radius: 3pt;
-}
-
-div.sphinxsidebar p.caption {
-  display: none;
-}
-
-p.sidebar-title, .sidebar p {
-  margin: 6pt;
-}
-
-.sidebar li,
-.hlist li {
-  list-style-type: disclosure-closed;
-}
-
-.sphinxsidebar .current > a {
-  font-weight: bold;
-}
-
-/* admonitions
-*/
-
-div.admonition, div.topic, nav.contents, div.toctree-wrapper {
-  background-color: #fafafa;
-  margin: 8px 0px;
-  padding: 1em;
-  border-radius: 3pt 0 0 3pt;
-  border-top: none;
-  border-right: none;
-  border-bottom: none;
-  border-left: 5pt solid #ccc;
-  list-style-type: disclosure-closed;
-}
-
-div.toctree-wrapper p.caption {
-  font-weight: normal;
-  font-size: 24px;
-  margin: 0 0 10px 0;
-  padding: 0;
-  line-height: 1;
-  display: inline;
-}
-
-p.admonition-title:after {
-  content: none;
-}
-
-.admonition.hint      { border-color: #416dc0b0; }
-.admonition.note      { border-color: #6c856cb0; }
-.admonition.tip       { border-color: #85c5c2b0; }
-.admonition.attention { border-color: #ecec97b0; }
-.admonition.caution   { border-color: #a6c677b0; }
-.admonition.danger    { border-color: #d46262b0; }
-.admonition.important { border-color: #dfa3a3b0; }
-.admonition.error     { border-color: red; }
-.admonition.warning   { border-color: darkred; }
-
-.admonition.admonition-generic-admonition-title {
-    border-color: #416dc0b0;
-}
-
-
-/* admonitions with (rendered) reST markup examples (:class: rst-example)
- *
- * .. admonition:: title of the example
- *     :class: rst-example
- *     ....
-*/
-
-div.rst-example {
-  background-color: inherit;
-  margin: 0;
-  border-top: none;
-  border-right: 1px solid #ccc;
-  border-bottom: none;
-  border-left: none;
-  border-radius: none;
-  padding: 0;
-}
-
-div.rst-example > p.admonition-title {
-  font-family: Sans Serif;
-  font-style: italic;
-  font-size: 0.8em;
-  display: block;
-  border-bottom: 1px solid #ccc;
-  padding: 0.5em 1em;
-  text-align: right;
-}
-
-/* code block in figures
- */
-
-div.highlight pre {
-    text-align: left;
-}
-
-/* Table theme
-*/
-
-thead, tfoot {
-  background-color: #fff;
-}
-
-th:hover, td:hover {
-  background-color: #ffc;
-}
-
-thead th, tfoot th, tfoot td, tbody th {
-  background-color: #fffaef;
-}
-
-tbody tr:nth-child(odd) {
-  background-color: #fff;
-}
-
-tbody tr:nth-child(even) {
-  background-color: #fafafa;
-}
-
-caption {
-  font-family: Sans Serif;
-  padding: 0.5em;
-  margin: 0.5em 0 0.5em 0;
-  caption-side: top;
-  text-align: left;
-}
-
-div.sphinx-tabs {
-    clear: both;
-}

docs/_themes/searxng/theme.conf

@@ -1,7 +0,0 @@
-[theme]
-inherit = pocoo
-stylesheet = searxng.css
-
-[options]
-touch_icon =
-globaltoc_maxdepth = 5

docs/admin/buildhosts.rst

@@ -4,11 +4,6 @@
 Buildhosts
 ==========
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 To get best results from build, it's recommend to install additional packages on
 build hosts (see :ref:`searxng.sh`).
 

docs/admin/installation-apache.rst

@@ -61,11 +61,6 @@ section might give you some guidance.
    - `Apache Fedora`_
    - `Apache directives`_
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 
 The Apache HTTP server
 ======================

docs/admin/installation-nginx.rst

@@ -41,12 +41,6 @@ section might give you some guidance.
    - `uWSGI support from nginx`_
 
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 The nginx HTTP server
 =====================
 

docs/admin/installation-searxng.rst

@@ -4,12 +4,6 @@
 Step by step installation
 =========================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 In this section we show the setup of a SearXNG instance that will be installed
 by the :ref:`installation scripts`.
 

docs/admin/installation-uwsgi.rst

@@ -9,12 +9,6 @@ uWSGI
    - `systemd.unit`_
    - `uWSGI Emperor`_
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 .. _systemd.unit: https://www.freedesktop.org/software/systemd/man/systemd.unit.html
 .. _One service per app in systemd:
     https://uwsgi-docs.readthedocs.io/en/latest/Systemd.html#one-service-per-app-in-systemd

docs/admin/searx.favicons.rst

@@ -8,11 +8,6 @@ Favicons
 
    Don't activate the favicons before reading the documentation.
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 Activating the favicons in SearXNG is very easy, but this **generates a
 significantly higher load** in the client/server communication and increases
 resources needed on the server.
@@ -250,4 +245,3 @@ into the *proxy*:
 .. _data URL:
    https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
 .. _FQN: https://en.wikipedia.org/wiki/Fully_qualified_name
-

docs/admin/searx.limiter.rst

@@ -8,10 +8,5 @@ Limiter
 
    The limiter requires a :ref:`Valkey <settings valkey>` database.
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.limiter
    :members:

docs/admin/settings/settings.rst

@@ -12,11 +12,6 @@ file.
    - :ref:`use_default_settings.yml`
    - :ref:`search API`
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. _settings location:
 
 settings.yml location

docs/admin/settings/settings_plugins.rst

@@ -102,11 +102,18 @@ The built-in plugins are all located in the namespace `searx.plugins`.
 external plugins
 ================
 
+SearXNG supports :ref:`external plugins <dev plugin>` / there is no need to
+install one, SearXNG runs out of the box.
+
+`Only show green hosted results`_:
+  SearXNG plugin to check if a domain is part of the Green WEB.
+
+`SearXNG BM25 Reranker`_:
+  SearXNG plugin that reranks search results using BM25 text relevance scoring
+  to improve search quality.
+
 .. _Only show green hosted results:
     https://github.com/return42/tgwf-searx-plugins/
 
-SearXNG supports *external plugins* / there is no need to install one, SearXNG
-runs out of the box.
-
-- `Only show green hosted results`_
-- ..
+.. _SearXNG BM25 Reranker:
+    https://github.com/Oaklight/searxng-bm25-reranker

docs/admin/update-searxng.rst

@@ -9,11 +9,6 @@ SearXNG maintenance
    - :ref:`toolboxing`
    - :ref:`uWSGI maintenance`
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. _update searxng:
 
 How to update

docs/conf.py

@@ -1,8 +1,7 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
-import  sys, os
+import os
 from pathlib import Path
-from pallets_sphinx_themes import ProjectLink
 
 from searx import get_setting
 from searx.version import VERSION_STRING, GIT_URL, GIT_BRANCH
@@ -98,7 +97,6 @@ extlinks['pull-searx'] = ('https://github.com/searx/searx/pull/%s', 'PR %s')
 extlinks['origin'] = (GIT_URL + '/blob/' + GIT_BRANCH + '/%s', 'git://%s')
 extlinks['patch'] = (GIT_URL + '/commit/%s', '#%s')
 extlinks['docs'] = (DOCS_URL + '/%s', 'docs: %s')
-extlinks['pypi'] = ('https://pypi.org/project/%s', 'PyPi: %s')
 extlinks['man'] = ('https://manpages.debian.org/jump?q=%s', '%s')
 #extlinks['role'] = (
 #    'https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-%s', '')
@@ -117,7 +115,6 @@ extensions = [
     'sphinx.ext.viewcode',
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
-    "pallets_sphinx_themes",
     "sphinx_issues", # https://github.com/sloria/sphinx-issues/blob/master/README.rst
     "sphinx_jinja",  # https://github.com/tardyp/sphinx-jinja
     "sphinxcontrib.programoutput",  # https://github.com/NextThought/sphinxcontrib-programoutput
@@ -158,15 +155,49 @@ issues_github_path = "searxng/searxng"
 
 # HTML -----------------------------------------------------------------
 
+html_theme = "furo"
+html_theme_options = {
+    # link to project source at GitHub for editing and viewing docs code
+    "source_repository": "https://github.com/searxng/searxng/",
+    "source_branch": "master",
+    "source_directory": "docs/",
+
+    # Show link to repository & searx.space in footer
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/searxng/searxng/",
+            "html": "💾",
+        },
+        {
+            "name": "searx.space",
+            "url": "https://searx.space/",
+            "html": "🌐",
+        },
+    ],
+}
+
+html_sidebars = {
+    "**": [
+        "sidebar/scroll-start.html",
+        "sidebar/brand.html",
+        "sidebar/search.html",
+        "sidebar/navigation.html",
+        "sidebar/ethical-ads.html",
+        "sidebar/scroll-end.html",
+    ]
+}
+
+html_static_path = ['_static']
+
+html_css_files = [
+    'searxng.css',
+]
+
 # https://searxng.github.io/searxng --> '/searxng/'
 # https://docs.searxng.org --> '/'
 notfound_urls_prefix = '/'
 
-sys.path.append(os.path.abspath('_themes'))
-sys.path.insert(0, os.path.abspath("../"))
-html_theme_path = ['_themes']
-html_theme = "searxng"
-
 # sphinx.ext.imgmath setup
 html_math_renderer = 'imgmath'
 imgmath_image_format = 'svg'
@@ -174,34 +205,10 @@ imgmath_font_size = 14
 # sphinx.ext.imgmath setup END
 
 html_show_sphinx = False
-html_theme_options = {"index_sidebar_logo": True}
-html_context = {"project_links": [] }
-html_context["project_links"].append(ProjectLink("Source", GIT_URL + '/tree/' + GIT_BRANCH))
-
-if WIKI_URL:
-    html_context["project_links"].append(ProjectLink("Wiki", WIKI_URL))
-if PUBLIC_INSTANCES:
-    html_context["project_links"].append(ProjectLink("Public instances", PUBLIC_INSTANCES))
-if ISSUE_URL:
-    html_context["project_links"].append(ProjectLink("Issue Tracker", ISSUE_URL))
-if PRIVACYPOLICY_URL:
-    html_context["project_links"].append(ProjectLink("Privacy Policy", PRIVACYPOLICY_URL))
-if CONTACT_URL:
-    html_context["project_links"].append(ProjectLink("Contact", CONTACT_URL))
-
-html_sidebars = {
-    "**": [
-        "globaltoc.html",
-        "project.html",
-        "relations.html",
-        "searchbox.html",
-        "sourcelink.html"
-    ],
-}
-singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
 html_logo = "../client/simple/src/brand/searxng-wordmark.svg"
 html_title = "SearXNG Documentation ({})".format(VERSION_STRING)
 html_show_sourcelink = True
+html_copy_source = True
 
 # LaTeX ----------------------------------------------------------------
 

docs/dev/contribution_guide.rst

@@ -4,11 +4,6 @@
 How to contribute
 =================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 Prime directives: Privacy, Hackability
 ======================================
 

docs/dev/engines/demo/demo_offline.rst

@@ -4,11 +4,6 @@
 Demo Offline Engine
 ===================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.demo_offline
   :members:
 

docs/dev/engines/demo/demo_online.rst

@@ -4,11 +4,6 @@
 Demo Online Engine
 ==================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.demo_online
   :members:
 

docs/dev/engines/engine_overview.rst

@@ -4,11 +4,6 @@
 Engine Overview
 ===============
 
-.. contents::
-   :depth: 3
-   :local:
-   :backlinks: entry
-
 .. _metasearch-engine: https://en.wikipedia.org/wiki/Metasearch_engine
 
 .. sidebar:: Further reading ..

docs/dev/engines/index.rst

@@ -4,12 +4,6 @@
 Engine Implementations
 ======================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 .. toctree::
    :caption: Framework Components
    :maxdepth: 2

docs/dev/engines/json_engine.rst

@@ -4,10 +4,5 @@
 JSON Engine
 ============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.json_engine
   :members:

docs/dev/engines/mediawiki.rst

@@ -4,10 +4,5 @@
 MediaWiki Engine
 ================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.mediawiki
   :members:

docs/dev/engines/offline/command-line-engines.rst

@@ -9,11 +9,6 @@ Command Line Engines
    - :origin:`command.py <searx/engines/command.py>`
    - :ref:`offline engines`
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. sidebar:: info
 
    Initial sponsored by `Search and Discovery Fund

docs/dev/engines/offline/nosql-engines.rst

@@ -10,11 +10,6 @@ NoSQL databases
    - `valkey.io <https://valkey.io/>`_
    - `MongoDB <https://www.mongodb.com>`_
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. sidebar:: info
 
    Initial sponsored by `Search and Discovery Fund

docs/dev/engines/offline/search-indexer-engines.rst

@@ -7,11 +7,6 @@ Local Search APIs
    - `Comparison to alternatives
      <https://docs.meilisearch.com/learn/what_is_meilisearch/comparison_to_alternatives.html>`_
 
-.. contents::
-   :depth: 1
-   :local:
-   :backlinks: entry
-
 .. sidebar:: info
 
    Initial sponsored by `Search and Discovery Fund

docs/dev/engines/offline/sql-engines.rst

@@ -10,11 +10,6 @@ SQL Engines
    - `PostgreSQL <https://www.postgresql.org>`_
    - `MySQL <https://www.mysql.com>`_
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. sidebar:: info
 
    Initial sponsored by `Search and Discovery Fund

docs/dev/engines/online/adobe_stock.rst

@@ -4,10 +4,5 @@
 Adobe Stock
 ===========
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.adobe_stock
    :members:

docs/dev/engines/online/alpinelinux.rst

@@ -4,10 +4,5 @@
 Alpine Linux Packages
 =====================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.alpinelinux
    :members:

docs/dev/engines/online/annas_archive.rst

@@ -4,10 +4,5 @@
 Anna's Archive
 ==============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.annas_archive
    :members:

docs/dev/engines/online/archlinux.rst

@@ -4,11 +4,6 @@
 Arch Linux
 ==========
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.archlinux
   :members:
 

docs/dev/engines/online/bing.rst

@@ -4,12 +4,6 @@
 Bing Engines
 ============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 .. _bing web engine:
 
 Bing WEB

docs/dev/engines/online/bpb.rst

@@ -4,10 +4,5 @@
 Bpb
 ===
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.bpb
   :members:

docs/dev/engines/online/brave.rst

@@ -2,11 +2,6 @@
 Brave Engines
 =============
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 Brave offers two different engines for SearXNG:
 
 1. The standard engine (``brave``) uses the web interface.

docs/dev/engines/online/bt4g.rst

@@ -4,11 +4,6 @@
 BT4G
 ====
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.bt4g
   :members:
 

docs/dev/engines/online/core.rst

@@ -4,10 +4,5 @@
 CORE
 ====
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.core
    :members:

docs/dev/engines/online/dailymotion.rst

@@ -4,10 +4,5 @@
 Dailymotion
 ===========
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.dailymotion
   :members:

docs/dev/engines/online/duckduckgo.rst

@@ -4,11 +4,6 @@
 DuckDuckGo Engines
 ==================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.duckduckgo
    :members:
 

docs/dev/engines/online/google.rst

@@ -4,12 +4,6 @@
 Google Engines
 ==============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 .. _google API:
 
 Google API

docs/dev/engines/online/lemmy.rst

@@ -4,10 +4,5 @@
 Lemmy
 =====
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.lemmy
    :members:

docs/dev/engines/online/loc.rst

@@ -4,10 +4,5 @@
 Library of Congress
 ===================
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.loc
   :members:

docs/dev/engines/online/mastodon.rst

@@ -4,10 +4,5 @@
 Mastodon
 ========
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.mastodon
   :members:

docs/dev/engines/online/moviepilot.rst

@@ -4,10 +4,5 @@
 Moviepilot
 ==========
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.moviepilot
    :members:

docs/dev/engines/online/mrs.rst

@@ -4,10 +4,5 @@
 Matrix Rooms Search (MRS)
 =========================
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.mrs
    :members:

docs/dev/engines/online/mwmbl.rst

@@ -4,12 +4,6 @@
 Mwmbl Engine
 ============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 .. _mwmbl web engine:
 
 Mwmbl WEB

docs/dev/engines/online/odysee.rst

@@ -4,10 +4,5 @@
 Odysee
 ======
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.odysee
   :members:

docs/dev/engines/online/peertube.rst

@@ -4,12 +4,6 @@
 Peertube Engines
 ================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 .. _peertube video engine:
 
 Peertube Video

docs/dev/engines/online/piped.rst

@@ -4,10 +4,5 @@
 Piped
 =====
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.piped
   :members:

docs/dev/engines/online/presearch.rst

@@ -4,10 +4,5 @@
 Presearch Engine
 ================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.presearch
    :members:

docs/dev/engines/online/qwant.rst

@@ -4,10 +4,5 @@
 Qwant
 =====
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.qwant
    :members:

docs/dev/engines/online/radio_browser.rst

@@ -4,10 +4,5 @@
 RadioBrowser
 ============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.radio_browser
    :members:

docs/dev/engines/online/recoll.rst

@@ -4,10 +4,5 @@
 Recoll Engine
 =============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.recoll
    :members:

docs/dev/engines/online/soundcloud.rst

@@ -4,10 +4,5 @@
 Soundcloud
 ==========
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.soundcloud
    :members:

docs/dev/engines/online/startpage.rst

@@ -4,10 +4,5 @@
 Startpage Engines
 =================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.startpage
    :members:

docs/dev/engines/online/tagesschau.rst

@@ -4,10 +4,5 @@
 Tagesschau API
 ==============
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.tagesschau
   :members:

docs/dev/engines/online/torznab.rst

@@ -4,10 +4,5 @@
 Torznab WebAPI
 ==============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.torznab
    :members:

docs/dev/engines/online/void.rst

@@ -4,10 +4,5 @@
 Void Linux binary packages
 ==========================
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.voidlinux
   :members:

docs/dev/engines/online/wallhaven.rst

@@ -4,10 +4,5 @@
 Wallhaven
 =========
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.wallhaven
   :members:

docs/dev/engines/online/wikipedia.rst

@@ -4,12 +4,6 @@
 Wikimedia
 =========
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 .. _wikipedia engine:
 
 Wikipedia

docs/dev/engines/online/yacy.rst

@@ -4,10 +4,5 @@
 Yacy
 ====
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.yacy
   :members:

docs/dev/engines/online/yahoo.rst

@@ -4,10 +4,5 @@
 Yahoo Engine
 ============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.yahoo
   :members:

docs/dev/engines/online/zlibrary.rst

@@ -4,10 +4,5 @@
 Z-Library
 =========
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.zlibrary
   :members:

docs/dev/engines/online_url_search/tineye.rst

@@ -4,11 +4,6 @@
 Tineye
 ======
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.tineye
   :members:
 

docs/dev/engines/xpath.rst

@@ -4,11 +4,6 @@
 XPath Engine
 ============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.engines.xpath
   :members:
 

docs/dev/makefile.rst

@@ -19,11 +19,6 @@ Makefiles, we recommend to read gnu-make_ introduction.
    To install developer requirements follow :ref:`buildhosts`.
 
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 The usage is simple, just type ``make {target-name}`` to *build* a target.
 Calling the ``help`` target gives a first overview (``make help``):
 

docs/dev/reST.rst

@@ -36,12 +36,6 @@ docs.live <make docs.live>` to build HTML while editing.
    - SVG_, ImageMagick_
    - DOT_, `Graphviz's dot`_, Graphviz_
 
-
-.. contents::
-   :depth: 3
-   :local:
-   :backlinks: entry
-
 Sphinx_ and reST_ have their place in the python ecosystem.  Over that reST is
 used in popular projects, e.g the Linux kernel documentation `[kernel doc]`_.
 

docs/dev/templates.rst

@@ -14,11 +14,6 @@ type of a result is defined by the :py:obj:`result_type.Result.template`.  To
 set another media-type as :ref:`template default`, the field ``template``
 in the result item must be set to the desired type.
 
-.. contents:: Contents
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 
 .. _result template macros:
 

docs/own-instance.rst

@@ -7,11 +7,6 @@ Why use a private instance?
   \.\.\.is a common question among SearXNG users.  Before answering this
   question, see what options a SearXNG user has.
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 Public instances are open to everyone who has access to their URL.  Usually, they
 are operated by unknown parties (from the users' point of view).  Private
 instances can be used by a select group of people, such as a SearXNG instance for a

docs/src/searx.botdetection.rst

@@ -4,11 +4,6 @@
 Bot Detection
 =============
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.botdetection
   :members:
 

docs/src/searx.favicons.rst

@@ -4,11 +4,6 @@
 Favicons (source)
 =================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.favicons
    :members:
 
@@ -43,6 +38,3 @@ Favicons Cache
 
 .. automodule:: searx.favicons.cache
    :members:
-
-
-

docs/src/searx.locales.rst

@@ -4,11 +4,6 @@
 Locales
 =======
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. automodule:: searx.locales
    :members:
 

docs/src/searx.search.processors.rst

@@ -4,12 +4,6 @@
 Search processors
 =================
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 Abstract processor class
 ========================
 

docs/user/configured_engines.rst

@@ -22,11 +22,6 @@ Configured Engines
    called *tabs*), engines can be queried by their name or the categories they
    belong to, by using a :ref:`\!bing syntax <search-syntax>`.
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
 .. jinja:: searx
 
    {% for category, engines in categories_as_tabs.items() %}

docs/user/index.rst

@@ -2,11 +2,6 @@
 User information
 ================
 
-.. contents::
-   :depth: 3
-   :local:
-   :backlinks: entry
-
 .. toctree::
    :maxdepth: 2
 

docs/utils/searxng.sh.rst

@@ -15,12 +15,6 @@ script :origin:`utils/searxng.sh`.
    - :ref:`installation nginx`
    - :ref:`installation apache`
 
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: entry
-
-
 Install
 =======
 

requirements-dev.txt

@@ -5,12 +5,12 @@ black==25.9.0
 pylint==4.0.5
 splinter==0.21.0
 selenium==4.43.0
-Pallets-Sphinx-Themes==2.5.0
 Sphinx==8.2.3;python_version <= "3.11"
 Sphinx==9.1.0; python_version > "3.11"
 sphinx-issues==6.0.0
 sphinx-jinja==2.0.2
 sphinx-tabs==3.5.0
+furo==2025.12.19
 sphinxcontrib-programoutput==0.19
 sphinx-autobuild==2025.8.25
 sphinx-notfound-page==1.1.0

searx/engines/startpage.py

@@ -345,7 +345,10 @@ def _get_news_result(result):
 
     publishedDate = None
     if result.get("date"):
-        publishedDate = datetime.fromtimestamp(result["date"] / 1000)
+        try:
+            publishedDate = datetime.fromtimestamp(int(result["date"]) / 1000)
+        except (TypeError, ValueError):
+            pass
 
     thumbnailUrl = None
     if result.get("thumbnailUrl"):

searx/engines/yep.py

@@ -1,10 +1,17 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 """Yep (general, images, news)"""
 
-from datetime import datetime
+import typing as t
+
 from urllib.parse import urlencode
+
+from searx.result_types import EngineResults
 from searx.utils import html_to_text
 
+if t.TYPE_CHECKING:
+    from searx.extended_types import SXNG_Response
+    from searx.search.processors import OnlineParams
+
 about = {
     'website': 'https://yep.com/',
     'official_api_documentation': 'https://docs.developer.yelp.com',
@@ -14,69 +21,32 @@ about = {
 }
 
 base_url = "https://api.yep.com"
-search_type = "web"  # 'web', 'images', 'news'
 
 safesearch = True
 safesearch_map = {0: 'off', 1: 'moderate', 2: 'strict'}
 
 enable_http2 = False
 
+results_per_page = 20
 
-def request(query, params):
-    args = {
-        'client': 'web',
-        'no_correct': 'false',
-        'q': query,
-        'safeSearch': safesearch_map[params['safesearch']],
-        'type': search_type,
-    }
+
+def request(query: str, params: 'OnlineParams') -> None:
+    args = {'query': query, 'safeSearch': safesearch_map[params['safesearch']], 'limit': results_per_page}
     params['url'] = f"{base_url}/fs/2/search?{urlencode(args)}"
     params['headers']['Referer'] = 'https://yep.com/'
     params['headers']['Origin'] = 'https://yep.com'
-    return params
 
 
-def _web_result(result):
-    return {
-        'url': result['url'],
-        'title': result['title'],
-        'content': html_to_text(result['snippet']),
-    }
-
-
-def _images_result(result):
-    return {
-        'template': 'images.html',
-        'url': result['host_page'],
-        'title': result.get('title', ''),
-        'content': '',
-        'img_src': result['image_id'],
-        'thumbnail_src': result['src'],
-    }
-
-
-def _news_result(result):
-    return {
-        'url': result['url'],
-        'title': result['title'],
-        'content': html_to_text(result['snippet']),
-        'publishedDate': datetime.strptime(result['first_seen'][:19], '%Y-%m-%dT%H:%M:%S'),
-    }
-
-
-def response(resp):
-    results = []
+def response(resp: 'SXNG_Response') -> EngineResults:
+    res = EngineResults()
 
     for result in resp.json()[1]['results']:
-        if search_type == "web":
-            if result['type'] != 'Organic':
-                continue
-            results.append(_web_result(result))
-        elif search_type == "images":
-            results.append(_images_result(result))
-        elif search_type == "news":
-            results.append(_news_result(result))
-        else:
-            raise ValueError(f"Unsupported yep search type: {search_type}")
+        res.add(
+            res.types.MainResult(
+                url=result['url'],
+                title=result['title'],
+                content=html_to_text(result['snippet']),
+            )
+        )
 
-    return results
+    return res

searx/settings.yml

@@ -688,22 +688,6 @@ engines:
     engine: yep
     shortcut: yep
     categories: general
-    search_type: web
-    timeout: 15
-    disabled: true
-
-  - name: yep images
-    engine: yep
-    shortcut: yepi
-    categories: images
-    search_type: images
-    disabled: true
-
-  - name: yep news
-    engine: yep
-    shortcut: yepn
-    categories: news
-    search_type: news
     disabled: true
 
   - name: currency
@@ -1229,7 +1213,7 @@ engines:
 
   - name: karmasearch videos
     engine: karmasearch
-    categories: [general, web]
+    categories: [videos, web]
     search_type: videos
     shortcut: kav
 

searx/templates/simple/macros.html

@@ -67,3 +67,13 @@
          class="checkbox-onoff"{{- ' ' -}}
          {%- if checked -%} checked{%- endif -%}/>
 {%- endmacro -%}
+
+<!-- iframe that additionally sets some extra feature attrs for videos -->
+{%- macro iframe(iframe_src) -%}
+  <iframe data-src="{{iframe_src}}" frameborder="0" allowfullscreen
+    {% if result.parsed_url.hostname in ("www.youtube.com", ) -%}
+    allow="picture-in-picture" referrerpolicy="origin"
+    {%- endif -%}
+    >
+  </iframe>
+{%- endmacro -%}

searx/templates/simple/result_templates/default.html

@@ -1,4 +1,4 @@
-{% from 'simple/macros.html' import result_header, result_sub_header, result_sub_footer, result_footer with context %}
+{% from 'simple/macros.html' import iframe, result_header, result_sub_header, result_sub_footer, result_footer with context %}
 
 {{ result_header(result, favicons, image_proxify) -}}
 {{- result_sub_header(result) -}}
@@ -17,7 +17,7 @@
 {{- result_sub_footer(result) -}}
 {% if result.iframe_src -%}
 <div id="result-media-{{ index }}" class="embedded-content invisible">
-  <iframe data-src="{{result.iframe_src}}" frameborder="0" allowfullscreen></iframe>
+  {{ iframe(result.iframe_src) }}
 </div>
 {%- endif %}
 {% if result.audio_src -%}

searx/templates/simple/result_templates/videos.html

@@ -1,4 +1,4 @@
-{% from 'simple/macros.html' import result_header, result_sub_header, result_sub_footer, result_footer with context %}
+{% from 'simple/macros.html' import iframe, result_header, result_sub_header, result_sub_footer, result_footer with context %}
 
 {{ result_header(result, favicons, image_proxify) }}
 {{ result_sub_header(result) }}
@@ -18,11 +18,7 @@
 {{- result_sub_footer(result) -}}
 {% if result.iframe_src -%}
 <div id="result-video-{{ index }}" class="embedded-video invisible">
-  <iframe data-src="{{result.iframe_src}}" frameborder="0" allowfullscreen
-    {% if result.parsed_url.hostname in ("www.youtube.com", ) -%}
-    allow="picture-in-picture" referrerpolicy="origin">
-    {%- endif -%}
-  </iframe>
+  {{ iframe(result.iframe_src) }}
 </div>
 {%- endif %}
 {{ result_footer(result) }}