diff options
| author | Markus Heiser <markus.heiser@darmarIT.de> | 2025-10-10 16:14:29 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-10-10 16:14:29 +0200 |
| commit | 21d0428cf2dd5c1e3f8ae1702494bbaedf90c2fc (patch) | |
| tree | 0e093ddfb89ce4ee7f9b58eb4f2fde9dcbedae17 /docs/admin/settings/settings_brand.rst | |
| parent | f0dfe3cc0e2b9fce3e69a7525ab5fa073dbd459e (diff) | |
[mod] brand - partial migration of settings to msgspec.Struct (#5280)
The settings are currently an untyped key/value structure, whose types are
dynamically built at runtime. The construction process of this structure
is *hand-crafted*.
In the long term, we want a static typing of this structure, based on a standard
tool. The ``msgspec.Struct`` structures are suitable as a standard tool.
This patch makes a first step towards static typing and implements the "brand"
section using ``msgspec.Struct`` structures.
BTW: searx/settings_defaults.py - ``git_url`` and ``git_branch`` had been
removed in aee613d256, this is a leftover.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin/settings/settings_brand.rst')
| -rw-r--r-- | docs/admin/settings/settings_brand.rst | 21 |
1 files changed, 2 insertions, 19 deletions
diff --git a/docs/admin/settings/settings_brand.rst b/docs/admin/settings/settings_brand.rst index 0f1a0d9a9..6bd320cdc 100644 --- a/docs/admin/settings/settings_brand.rst +++ b/docs/admin/settings/settings_brand.rst @@ -4,22 +4,5 @@ ``brand:`` ========== -.. code:: yaml - - brand: - issue_url: https://github.com/searxng/searxng/issues - docs_url: https://docs.searxng.org - public_instances: https://searx.space - wiki_url: https://github.com/searxng/searxng/wiki - -``issue_url`` : - If you host your own issue tracker change this URL. - -``docs_url`` : - If you host your own documentation change this URL. - -``public_instances`` : - If you host your own https://searx.space change this URL. - -``wiki_url`` : - Link to your wiki (or ``false``) +.. autoclass:: searx.brand.SettingsBrand + :members: |