diff options
author | Bnyro <bnyro@tutanota.com> | 2024-02-19 21:06:26 +0100 |
---|---|---|
committer | Markus Heiser <markus.heiser@darmarIT.de> | 2024-02-25 14:56:57 +0100 |
commit | 60d8414ef158e648176f0d0f6cfef6ab709c4a53 (patch) | |
tree | afa36b09b5520aa0e495dcdc5a95a939d5f98bd3 /docs | |
parent | 34fa2b7cca76d7484741e8906aeb7d52f82361c3 (diff) | |
download | searxng-60d8414ef158e648176f0d0f6cfef6ab709c4a53.tar.gz searxng-60d8414ef158e648176f0d0f6cfef6ab709c4a53.zip |
[docs] engine_overview: add packages result template
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/engines/engine_overview.rst | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/dev/engines/engine_overview.rst b/docs/dev/engines/engine_overview.rst index 00c766f2f..9c1ea0427 100644 --- a/docs/dev/engines/engine_overview.rst +++ b/docs/dev/engines/engine_overview.rst @@ -466,3 +466,68 @@ type. - :py:class:`str` - URL to full article, HTML version + +.. _template packages: + +``packages`` +------------ + +.. list-table:: Parameter of the **packages** media type + :header-rows: 2 + :width: 100% + + * - result-parameter + - Python type + - information + + * - template + - :py:class:`str` + - is set to ``packages.html`` + + * - title + - :py:class:`str` + - title of the result + + * - content + - :py:class:`str` + - abstract + + * - package_name + - :py:class:`str` + - the name of the package + + * - version + - :py:class:`str` + - the current version of the package + + * - maintainer + - :py:class:`str` + - the maintainer or author of the project + + * - publishedDate + - :py:class:`datetime <datetime.datetime>` + - date of latest update or release + + * - tags + - :py:class:`List <list>`\ [\ :py:class:`str`\ ] + - free tag list + + * - popularity + - :py:class:`str` + - the popularity of the package, e.g. rating or download count + + * - license_name + - :py:class:`str` + - the name of the license + + * - license_url + - :py:class:`str` + - the web location of a license copy + + * - homepage + - :py:class:`str` + - the url of the project's homepage + + * - source_code_url + - :py:class:`str` + - the location of the project's source code |