summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2025-08-21 17:57:58 +0200
committerMarkus Heiser <markus.heiser@darmarIT.de>2025-09-01 14:51:15 +0200
commit9ac9c8c4f50acd801bfc39107c94d17ee9bee72b (patch)
tree0545c9e9ae37462cfd64b5e85620453ffe2981c8 /docs
parentb8085d27aca35b3c60ef50bf0683018d6a6b51b3 (diff)
[mod] typification of SearXNG: add new result type Code
This patch adds a new result type: Code - Python class: searx/result_types/code.py - Jinja template: searx/templates/simple/result_templates/code.html - CSS (less) client/simple/src/less/result_types/code.less Signed-of-by: Markus Heiser <markus.heiser@darmarIT.de>
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py1
-rw-r--r--docs/dev/result_types/main/code.rst7
-rw-r--r--docs/dev/result_types/main_result.rst2
-rw-r--r--docs/dev/templates.rst27
4 files changed, 9 insertions, 28 deletions
diff --git a/docs/conf.py b/docs/conf.py
index a7221e48b..2d730f58c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -150,6 +150,7 @@ intersphinx_mapping = {
"linuxdoc" : ("https://return42.github.io/linuxdoc/", None),
"sphinx" : ("https://www.sphinx-doc.org/en/master/", None),
"valkey": ('https://valkey-py.readthedocs.io/en/stable/', None),
+ "pygments": ("https://pygments.org/", None),
}
issues_github_path = "searxng/searxng"
diff --git a/docs/dev/result_types/main/code.rst b/docs/dev/result_types/main/code.rst
new file mode 100644
index 000000000..399cbd26e
--- /dev/null
+++ b/docs/dev/result_types/main/code.rst
@@ -0,0 +1,7 @@
+.. _result_types.code:
+
+============
+Code Results
+============
+
+.. automodule:: searx.result_types.code
diff --git a/docs/dev/result_types/main_result.rst b/docs/dev/result_types/main_result.rst
index a76ed5e88..f072ea757 100644
--- a/docs/dev/result_types/main_result.rst
+++ b/docs/dev/result_types/main_result.rst
@@ -15,6 +15,7 @@ following types have been implemented so far ..
main/mainresult
main/keyvalue
+ main/code
The :ref:`LegacyResult <LegacyResult>` is used internally for the results that
have not yet been typed. The templates can be used as orientation until the
@@ -27,6 +28,5 @@ final typing is complete.
- :ref:`template map`
- :ref:`template paper`
- :ref:`template packages`
-- :ref:`template code`
- :ref:`template files`
- :ref:`template products`
diff --git a/docs/dev/templates.rst b/docs/dev/templates.rst
index 3633eb2ef..e2fa879c8 100644
--- a/docs/dev/templates.rst
+++ b/docs/dev/templates.rst
@@ -469,33 +469,6 @@ links : :py:class:`dict`
Additional links in the form of ``{'link_name': 'http://example.com'}``
-.. _template code:
-
-``code.html``
--------------
-
-Displays result fields from:
-
-- :ref:`macro result_header` and
-- :ref:`macro result_sub_header`
-
-Additional fields used in the :origin:`code.html
-<searx/templates/simple/result_templates/code.html>`:
-
-content : :py:class:`str`
- Description of the code fragment.
-
-codelines : ``[line1, line2, ...]``
- Lines of the code fragment.
-
-code_language : :py:class:`str`
- Name of the code language, the value is passed to
- :py:obj:`pygments.lexers.get_lexer_by_name`.
-
-repository : :py:class:`str`
- URL of the repository of the code fragment.
-
-
.. _template files:
``files.html``