[mod] move brand options from Makefile to settings.yml

# -*- coding: utf-8; mode: makefile-gmake -*-

.DEFAULT_GOAL=help

# START Makefile setup

export GIT_URL=https://github.com/searx/searx

export GIT_BRANCH=master

export SEARX_URL=https://searx.me

export DOCS_URL=https://searx.github.io/searx

# export CONTACT_URL=mailto:contact@example.com

# END Makefile setup

include utils/makefile.include

PYOBJECTS = searx

	@echo  '  docker    - build Docker image'

	@echo  '  node.env  - download & install npm dependencies locally'

	@echo  ''

	@echo  'environment'

	@echo  '  SEARX_URL = $(SEARX_URL)'

	@echo  '  GIT_URL   = $(GIT_URL)'

	@echo  '  DOCS_URL  = $(DOCS_URL)'

	@echo  '  CONTACT_URL = $(CONTACT_URL)'

	@echo  ''

	@$(MAKE) -e -s make-help

help-all: help-min

	$(Q)echo "Update searx/data/useragents.json with the most recent versions of Firefox."

	$(Q)$(PY_ENV_ACT); python utils/fetch_firefox_version.py

buildenv:

	$(Q)echo "build searx/brand.py"

	$(Q)echo "GIT_URL = '$(GIT_URL)'"  > searx/brand.py

	$(Q)echo "GIT_BRANCH = '$(GIT_BRANCH)'"  >> searx/brand.py

	$(Q)echo "ISSUE_URL = 'https://github.com/searx/searx/issues'" >> searx/brand.py

	$(Q)echo "SEARX_URL = '$(SEARX_URL)'" >> searx/brand.py

	$(Q)echo "DOCS_URL = '$(DOCS_URL)'" >> searx/brand.py

	$(Q)echo "PUBLIC_INSTANCES = 'https://searx.space'" >> searx/brand.py

	$(Q)echo "CONTACT_URL = '$(CONTACT_URL)'" >> searx/brand.py

	$(Q)echo "build utils/brand.env"

	$(Q)echo "export GIT_URL='$(GIT_URL)'"  > utils/brand.env

	$(Q)echo "export GIT_BRANCH='$(GIT_BRANCH)'"  >> utils/brand.env

	$(Q)echo "export ISSUE_URL='https://github.com/searx/searx/issues'" >> utils/brand.env

	$(Q)echo "export SEARX_URL='$(SEARX_URL)'" >> utils/brand.env

	$(Q)echo "export DOCS_URL='$(DOCS_URL)'" >> utils/brand.env

	$(Q)echo "export PUBLIC_INSTANCES='https://searx.space'" >> utils/brand.env

	$(Q)echo "export CONTACT_URL='$(CONTACT_URL)'" >> utils/brand.env

buildenv: pyenv

	$(Q)$(PY_ENV_ACT); SEARX_DEBUG=1 python utils/build_env.py

# node / npm

# ----------

.. tip::

   About script's installation options have a look at chapter :ref:`toolboxing

   setup`.  How to brand your instance see chapter :ref:`makefile setup`.  To

   setup`.  How to brand your instance see chapter :ref:`settings global`.  To

   *stash* your instance's setup, `git stash`_ your clone's :origin:`Makefile`

   and :origin:`.config.sh` file .

   general:

       debug : False # Debug mode, only for development

       instance_name : "searx" # displayed name

       git_url: https://github.com/searx/searx

       git_branch: master

       issue_url: https://github.com/searx/searx/issues

       docs_url: https://searx.github.io/searx

       public_instances: https://searx.space

       contact_url: False # mailto:contact@example.com

       wiki_url: https://github.com/searx/searx/wiki

       twitter_url: https://twitter.com/Searx_engine

``debug`` :

  Allow a more detailed log if you run searx directly. Display *detailed* error

  messages in the browser too, so this must be deactivated in production.

``contact_url``:

  Contact mail address or WEB form.

``git_url`` and ``git_branch``:

  Changes this, to point to your searx fork (branch).

``docs_url``

  If you host your own documentation, change this URL.

``wiki_url``:

  Link to your wiki (or ``False``)

``twitter_url``:

  Link to your tweets (or ``False``)

.. code:: yaml

   server:

- virtualenv in: ``/usr/local/searx/searx-pyenv``

- searx software in: ``/usr/local/searx/searx-src``

The searx software is a clone of the ``GIT_URL`` (see :ref:`makefile setup`) and

the working tree is checked out from the ``GIT_BRANCH``.  With the use of the

The searx software is a clone of the ``git_url`` (see :ref:`settings global`) and

the working tree is checked out from the ``git_branch``.  With the use of the

:ref:`searx.sh` the searx service was installed as :ref:`uWSGI application

<searx uwsgi>`.  To maintain this service, we can use ``systemctl`` (compare

:ref:`service architectures on distributions <uwsgi configuration>`).

import  sys, os

from sphinx_build_tools import load_sphinx_config

from searx.version import VERSION_STRING

from pallets_sphinx_themes import ProjectLink

from searx.brand import GIT_URL

GIT_BRANCH = os.environ.get("GIT_BRANCH", "master")

from searx.brand import SEARX_URL

from searx.brand import DOCS_URL

from searx import brand

from searx.version import VERSION_STRING

# Project --------------------------------------------------------------

extlinks['pull'] = ('https://github.com/searx/searx/pull/%s', 'PR ')

# links to custom brand

extlinks['origin'] = (GIT_URL + '/blob/' + GIT_BRANCH + '/%s', 'git://')

extlinks['patch'] = (GIT_URL + '/commit/%s', '#')

extlinks['search'] = (SEARX_URL + '/%s', '#')

extlinks['docs'] = (DOCS_URL + '/%s', 'docs: ')

extlinks['origin'] = (brand.GIT_URL + '/blob/' + brand.GIT_BRANCH + '/%s', 'git://')

extlinks['patch'] = (brand.GIT_URL + '/commit/%s', '#')

extlinks['search'] = (brand.SEARX_URL + '/%s', '#')

extlinks['docs'] = (brand.DOCS_URL + '/%s', 'docs: ')

extlinks['pypi'] = ('https://pypi.org/project/%s', 'PyPi: ')

extlinks['man'] = ('https://manpages.debian.org/jump?q=%s', '')

#extlinks['role'] = (

# sphinx.ext.imgmath setup END

html_theme_options = {"index_sidebar_logo": True}

html_context = {

    "project_links": [

        ProjectLink("Source", GIT_URL),

        ProjectLink("Wiki", "https://github.com/searx/searx/wiki"),

        ProjectLink("Public instances", "https://searx.space/"),

        ProjectLink("Twitter", "https://twitter.com/Searx_engine"),

    ]

}

html_context = {"project_links": [] }

if brand.GIT_URL:

    html_context["project_links"].append(ProjectLink("Source", brand.GIT_URL))

if brand.WIKI_URL:

    html_context["project_links"].append(ProjectLink("Wiki", brand.WIKI_URL))

if brand.PUBLIC_INSTANCES:

    html_context["project_links"].append(ProjectLink("Public instances", brand.PUBLIC_INSTANCES))

if brand.TWITTER_URL:

    html_context["project_links"].append(ProjectLink("Twitter", brand.TWITTER_URL))

if brand.ISSUE_URL:

    html_context["project_links"].append(ProjectLink("Issue Tracker", brand.ISSUE_URL))

if brand.CONTACT_URL:

    html_context["project_links"].append(ProjectLink("Contact", brand.CONTACT_URL))

html_sidebars = {

    "**": ["project.html", "relations.html", "searchbox.html"],

}