[mod] replace makefile boilerplate by 'manage' script

Replaces the make targets with the bash scripts

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

.github/workflows/data-update.yml

@@ -40,8 +40,7 @@ jobs:
         env:
           FETCH_SCRIPT: ./searx_extra/update/${{ matrix.fetch }}
         run: |
-          source local/py3/bin/activate
-          $FETCH_SCRIPT
+          V=1 manage pyenv.cmd python "$FETCH_SCRIPT"
 
       - name: Create Pull Request
         id: cpr

.github/workflows/integration.yml

@@ -59,7 +59,7 @@ jobs:
     - name: Install node dependencies
       run: make V=1 node.env
     - name: Build themes
-      run: make V=1 themes
+      run: make V=1 themes.all
 
   documentation:
     name: Documentation
@@ -77,14 +77,15 @@ jobs:
         python-version: '3.9'
         architecture: 'x64'
     - name: Build documentation
-      run: SEARX_DEBUG=1 make V=1 ci-gh-pages
+      run: |
+        make V=1 docs.clean docs.html
     - name: Deploy
       if:  github.ref == 'refs/heads/master'
       uses: JamesIves/github-pages-deploy-action@3.7.1
       with:
         GITHUB_TOKEN: ${{ github.token }}
         BRANCH: gh-pages
-        FOLDER: build/gh-pages
+        FOLDER: dist/docs
         CLEAN: true # Automatically remove deleted files from the deploy branch
 
   dockers:

Makefile

@@ -1,268 +1,107 @@
 # -*- coding: utf-8; mode: makefile-gmake -*-
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
 .DEFAULT_GOAL=help
+export MTOOLS=./manage
 
 include utils/makefile.include
 
-PYOBJECTS = searx
-DOC       = docs
-PY_SETUP_EXTRAS ?= \[test\]
-PYLINT_SEARX_DISABLE_OPTION := I,C,R,W0105,W0212,W0511,W0603,W0613,W0621,W0702,W0703,W1401,E1136
-PYLINT_ADDITIONAL_BUILTINS_FOR_ENGINES := supported_languages,language_aliases
-
-include utils/makefile.python
-include utils/makefile.sphinx
-
 all: clean install
 
-PHONY += help-min help-all help
-
-help: help-min
-	@echo  ''
-	@echo  'to get more help:  make help-all'
-
-help-min:
-	@echo  '  test      - run developer tests'
-	@echo  '  docs      - build documentation'
-	@echo  '  docs-live - autobuild HTML documentation while editing'
-	@echo  '  run       - run developer instance'
-	@echo  '  install   - developer install (./local)'
-	@echo  '  uninstall - uninstall (./local)'
-	@echo  '  gh-pages  - build docs & deploy on gh-pages branch'
-	@echo  '  clean     - drop builds and environments'
-	@echo  '  project   - re-build generic files of the searx project'
-	@echo  '  buildenv  - re-build environment files (aka brand)'
-	@echo  '  themes    - re-build build the source of the themes'
-	@echo  '  docker    - build Docker image'
-	@echo  '  node.env  - download & install npm dependencies locally'
-	@echo  ''
-	@$(MAKE) -e -s make-help
-
-help-all: help-min
-	@echo  ''
-	@$(MAKE) -e -s python-help
-	@echo  ''
-	@$(MAKE) -e -s docs-help
+PHONY += help
 
-PHONY += install
-install: buildenv pyenvinstall
+help:
+	@./manage --help
+	@echo '----'
+	@echo 'run            - run developer instance'
+	@echo 'install        - developer install of searx into virtualenv'
+	@echo 'uninstall      - uninstall developer installation'
+	@echo 'clean          - clean up working tree'
+	@echo 'search.checker - check search engines'
+	@echo 'test           - run shell & CI tests'
+	@echo 'test.sh        - test shell scripts'
+	@echo 'ci.test        - run CI tests'
 
-PHONY += uninstall
-uninstall: pyenvuninstall
-
-PHONY += clean
-clean: pyclean docs-clean node.clean test.clean
-	$(call cmd,common_clean)
 
 PHONY += run
-run:  buildenv pyenvinstall
+run:  install
 	$(Q) ( \
 	sleep 2 ; \
 	xdg-open http://127.0.0.1:8888/ ; \
 	) &
-	SEARX_DEBUG=1 $(PY_ENV)/bin/python ./searx/webapp.py
-
-# docs
-# ----
-
-sphinx-doc-prebuilds:: buildenv pyenvinstall prebuild-includes
-
-PHONY += docs
-docs:  sphinx-doc-prebuilds
-	$(call cmd,sphinx,html,docs,docs)
-
-PHONY += docs-live
-docs-live:  sphinx-doc-prebuilds
-	$(call cmd,sphinx_autobuild,html,docs,docs)
-
-PHONY += prebuild-includes
-prebuild-includes:
-	$(Q)mkdir -p $(DOCS_BUILD)/includes
-	$(Q)./utils/searx.sh doc | cat > $(DOCS_BUILD)/includes/searx.rst
-	$(Q)./utils/filtron.sh doc | cat > $(DOCS_BUILD)/includes/filtron.rst
-	$(Q)./utils/morty.sh doc | cat > $(DOCS_BUILD)/includes/morty.rst
-
-
-$(GH_PAGES)::
-	@echo "doc available at --> $(DOCS_URL)"
-
-# update project files
-# --------------------
-
-PHONY += project engines.languages useragents.update buildenv
-
-project: buildenv useragents.update engines.languages
-
-engines.languages:  pyenvinstall
-	$(Q)echo "fetch languages .."
-	$(Q)$(PY_ENV_ACT); python ./searx_extra/update/update_languages.py
-	$(Q)echo "updated searx/data/engines_languages.json"
-	$(Q)echo "updated searx/languages.py"
-
-useragents.update:  pyenvinstall
-	$(Q)echo "fetch useragents .."
-	$(Q)$(PY_ENV_ACT); python ./searx_extra/update/update_firefox_version.py
-	$(Q)echo "updated searx/data/useragents.json with the most recent versions of Firefox."
-
-buildenv: pyenv
-	$(Q)$(PY_ENV_ACT); SEARX_DEBUG=1 python utils/build_env.py
-
-# node / npm
-# ----------
-
-node.env: buildenv
-	$(Q)./manage.sh npm_packages
+	SEARX_DEBUG=1 ./manage pyenv.cmd python ./searx/webapp.py
 
-node.clean:
-	$(Q)echo "CLEAN     locally installed npm dependencies"
-	$(Q)rm -rf \
-	  ./node_modules  \
-	  ./package-lock.json \
-	  ./searx/static/themes/oscar/package-lock.json \
-	  ./searx/static/themes/oscar/node_modules \
-	  ./searx/static/themes/simple/package-lock.json \
-	  ./searx/static/themes/simple/node_modules
+PHONY += install uninstall
+install uninstall:
+	$(Q)./manage pyenv.$@
 
-# build themes
-# ------------
-
-PHONY += themes themes.oscar themes.simple
-themes: buildenv themes.oscar themes.simple
-
-quiet_cmd_lessc = LESSC     $3
-      cmd_lessc = PATH="$$(npm bin):$$PATH" \
-	lessc --clean-css="--s1 --advanced --compatibility=ie9" "searx/static/$2" "searx/static/$3"
-
-quiet_cmd_grunt = GRUNT     $2
-      cmd_grunt = PATH="$$(npm bin):$$PATH" \
-	grunt --gruntfile  "$2"
-
-themes.oscar: node.env
-	$(Q)echo '[!] build oscar theme'
-	$(call cmd,grunt,searx/static/themes/oscar/gruntfile.js)
-
-themes.simple: node.env
-	$(Q)echo '[!] build simple theme'
-	$(call cmd,grunt,searx/static/themes/simple/gruntfile.js)
-
-
-# docker
-# ------
-
-PHONY += docker
-docker: buildenv
-	$(Q)./manage.sh docker_build
-
-docker.push: buildenv
-	$(Q)./manage.sh docker_build push
-
-# gecko
-# -----
-
-PHONY += gecko.driver
-gecko.driver:
-	$(PY_ENV_ACT); ./manage.sh install_geckodriver
-
-# search.checker
-# --------------
-
-search.checker: pyenvinstall
-	$(Q)$(PY_ENV_ACT); searx-checker -v
-
-ENGINE_TARGETS=$(patsubst searx/engines/%.py,search.checker.%,$(wildcard searx/engines/[!_]*.py))
-
-$(ENGINE_TARGETS): pyenvinstall
-	$(Q)$(PY_ENV_ACT); searx-checker -v "$(subst _, ,$(patsubst search.checker.%,%,$@))"
-
-
-# test
-# ----
-
-PHONY += test test.sh test.pylint test.pep8 test.unit test.coverage test.robot
-test: buildenv test.pylint test.pep8 test.unit gecko.driver test.robot
-
-PYLINT_FILES=\
-	searx/preferences.py \
-	searx/testing.py \
-	searx/engines/gigablast.py \
-	searx/engines/deviantart.py \
-	searx/engines/digg.py \
-	searx/engines/google.py \
-	searx/engines/google_news.py \
-	searx/engines/google_videos.py \
-	searx/engines/google_images.py \
-	searx/engines/mediathekviewweb.py \
-	searx/engines/meilisearch.py \
-	searx/engines/solidtorrents.py \
-	searx/engines/solr.py \
-	searx/engines/springer.py \
-	searx/engines/google_scholar.py \
-	searx/engines/yahoo_news.py \
-	searx/engines/apkmirror.py \
-	searx/engines/artic.py \
-	searx_extra/update/update_external_bangs.py
-
-test.pylint: pyenvinstall
-	$(call cmd,pylint,$(PYLINT_FILES))
-	$(call cmd,pylint,\
-		--disable=$(PYLINT_SEARX_DISABLE_OPTION) \
-		--additional-builtins=$(PYLINT_ADDITIONAL_BUILTINS_FOR_ENGINES) \
-		searx/engines \
-	)
-	$(call cmd,pylint,\
-		--disable=$(PYLINT_SEARX_DISABLE_OPTION) \
-		--ignore=searx/engines \
-		searx tests \
-	)
+PHONY += clean
+clean: py.clean docs.clean node.clean test.clean
+	$(Q)./manage build_msg CLEAN  "common files"
+	$(Q)find . -name '*.orig' -exec rm -f {} +
+	$(Q)find . -name '*.rej' -exec rm -f {} +
+	$(Q)find . -name '*~' -exec rm -f {} +
+	$(Q)find . -name '*.bak' -exec rm -f {} +
+
+PHONY += search.checker search.checker.%
+search.checker: install
+	$(Q)./manage pyenv.cmd searx-checker -v
+
+search.checker.%: install
+	$(Q)./manage pyenv.cmd searx-checker -v "$(subst _, ,$(patsubst search.checker.%,%,$@))"
+
+PHONY += ci.test test test.sh
+ci.test: test.pep8 test.pylint test.unit test.robot
+test: ci.test
+test.sh:
+	$(Q)shellcheck -x -s bash \
+		utils/brand.env \
+		./manage \
+		utils/lib.sh \
+	        utils/filtron.sh \
+	        utils/searx.sh \
+	        utils/morty.sh \
+	        utils/lxc.sh \
+	        utils/lxc-searx.env \
+	        .config.sh
+	$(Q)./manage build_msg TEST "$@ OK"
 
-# ignored rules:
-#  E402 module level import not at top of file
-#  W503 line break before binary operator
 
-# ubu1604: uses shellcheck v0.3.7 (from 04/2015), no longer supported!
-test.sh:
-	shellcheck -x -s bash utils/brand.env
-	shellcheck -x utils/lib.sh
-	shellcheck -x utils/filtron.sh
-	shellcheck -x utils/searx.sh
-	shellcheck -x utils/morty.sh
-	shellcheck -x utils/lxc.sh
-	shellcheck -x utils/lxc-searx.env
-	shellcheck -x .config.sh
+# wrap ./manage script
 
-test.pep8: pyenvinstall
-	@echo "TEST      pycodestyle (formerly pep8)"
-	$(Q)$(PY_ENV_ACT); pycodestyle --exclude='searx/static, searx/languages.py, $(foreach f,$(PYLINT_FILES),$(f),)' \
-        --max-line-length=120 --ignore "E117,E252,E402,E722,E741,W503,W504,W605" searx tests
+MANAGE += buildenv
+MANAGE += babel.compile
+MANAGE += data.all data.languages data.useragents
+MANAGE += docs.html docs.live docs.gh-pages docs.prebuild docs.clean
+MANAGE += docker.build docker.push
+MANAGE += gecko.driver
+MANAGE += node.env node.clean
+MANAGE += py.build py.clean
+MANAGE += pyenv pyenv.install pyenv.uninstall
+MANAGE += pypi.upload pypi.upload.test
+MANAGE += test.pylint test.pep8 test.unit test.coverage test.robot test.clean
+MANAGE += themes.all themes.oscar themes.simple themes.bootstrap
 
-test.unit: pyenvinstall
-	@echo "TEST      tests/unit"
-	$(Q)$(PY_ENV_ACT); python -m nose2 -s tests/unit
+PHONY += $(MANAGE)
 
-test.coverage:  pyenvinstall
-	@echo "TEST      unit test coverage"
-	$(Q)$(PY_ENV_ACT); \
-	python -m nose2 -C --log-capture --with-coverage --coverage searx -s tests/unit \
-	&& coverage report \
-	&& coverage html \
+$(MANAGE):
+	$(Q)$(MTOOLS) $@
 
-test.robot: pyenvinstall gecko.driver
-	@echo "TEST      robot"
-	$(Q)$(PY_ENV_ACT); PYTHONPATH=. python searx/testing.py robot
+# deprecated
 
-test.clean:
-	@echo "CLEAN     intermediate test stuff"
-	$(Q)rm -rf geckodriver.log .coverage coverage/
+PHONY += docs docs-clean docs-live docker themes
 
+docs: docs.html
+	$(Q)./manage build_msg WARN $@ is deprecated use docs.html
 
-# travis
-# ------
+docs-clean: docs.clean
+	$(Q)./manage build_msg WARN $@ is deprecated use docs.clean
 
-PHONY += ci.test
-ci.test:
-	$(PY_ENV_BIN)/python -c "import yaml"  || make clean
-	$(MAKE) test
+docs-live: docs.live
+	$(Q)./manage build_msg WARN $@ is deprecated use docs.live
 
-travis.codecov:
-	$(Q)$(PY_ENV_BIN)/python -m pip install codecov
+docker:  docker.build
+	$(Q)./manage build_msg WARN $@ is deprecated use docker.build
 
-.PHONY: $(PHONY)
+themes: themes.all
+	$(Q)./manage build_msg WARN $@ is deprecated use themes.all

docs/conf.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
+# SPDX-License-Identifier: AGPL-3.0-or-later
 
 import  sys, os
-from sphinx_build_tools import load_sphinx_config
 from pallets_sphinx_themes import ProjectLink
 
 from searx import brand
@@ -128,9 +128,3 @@ html_show_sourcelink = False
 latex_documents = [
     (master_doc, "searx-{}.tex".format(VERSION_STRING), html_title, author, "manual")
 ]
-
-# ------------------------------------------------------------------------------
-# Since loadConfig overwrites settings from the global namespace, it has to be
-# the last statement in the conf.py file
-# ------------------------------------------------------------------------------
-load_sphinx_config(globals())

docs/user/conf.py

@@ -1,21 +0,0 @@
-# -*- coding: utf-8; mode: python -*-
-"""Configuration for the Searx user handbook
-"""
-project   = 'Searx User-HB'
-version   = release = VERSION_STRING
-
-intersphinx_mapping['searx'] = (brand.DOCS_URL, None)
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    ('index'                       # startdocname
-     , 'searx-user-hb.tex'         # targetname
-     , ''                          # take title from .rst
-     , author                      # author
-     , 'howto'                     # documentclass
-     , False                       # toctree_only
-    ),
-]
-

manage

@@ -11,6 +11,7 @@ source_dot_config
 
 # config
 
+PYOBJECTS="searx"
 PY_SETUP_EXTRAS='[test]'
 NPM_PACKAGES="less@2.7 less-plugin-clean-css grunt-cli"
 GECKODRIVER_VERSION="v0.28.0"
@@ -29,6 +30,15 @@ PYLINT_FILES=(
     searx/engines/google_videos.py
     searx/engines/google_images.py
     searx/engines/mediathekviewweb.py
+    searx/engines/meilisearch.py
+    searx/engines/solidtorrents.py
+    searx/engines/solr.py
+    searx/engines/springer.py
+    searx/engines/google_scholar.py
+    searx/engines/yahoo_news.py
+    searx/engines/apkmirror.py
+    searx/engines/artic.py
+    searx_extra/update/update_external_bangs.py
 )
 
 PYLINT_SEARX_DISABLE_OPTION="\
@@ -84,7 +94,6 @@ themes.* :
   all       : build all themes
   oscar     : build oscar theme
   simple    : build simple theme
-  bootstrap : less compile bootstrap.min.css CSS
 EOF
 }
 
@@ -114,18 +123,18 @@ data.all() {
     data.languages
     data.useragents
     build_msg DATA "update searx/data/ahmia_blacklist.txt"
-    pyenv.cmd python utils/fetch_ahmia_blacklist.py
+    pyenv.cmd python searx_extra/update/update_ahmia_blacklist.py
     build_msg DATA "update searx/data/wikidata_units.json"
-    pyenv.cmd python utils/fetch_wikidata_units.py
+    pyenv.cmd python searx_extra/update/update_wikidata_units.py
     build_msg DATA "update searx/data/currencies.json"
-    pyenv.cmd python utils/fetch_currencies.py
+    pyenv.cmd python searx_extra/update/update_currencies.py
 }
 
 
 data.languages() {
     (   set -e
         build_msg ENGINES "fetch languages .."
-        pyenv.cmd python utils/fetch_languages.py
+        pyenv.cmd python searx_extra/update/update_languages.py
         build_msg ENGINES "update update searx/languages.py"
         build_msg DATA "update searx/data/engines_languages.json"
     )
@@ -134,7 +143,7 @@ data.languages() {
 
 data.useragents() {
     build_msg DATA "update searx/data/useragents.json"
-    pyenv.cmd python utils/fetch_firefox_version.py
+    pyenv.cmd python searx_extra/update/update_firefox_version.py
     dump_return $?
 }
 
@@ -211,7 +220,7 @@ docker.build() {
 
         # define the docker image name
         GITHUB_USER=$(echo "${GIT_URL}" | sed 's/.*github\.com\/\([^\/]*\).*/\1/')
-        SEARX_IMAGE_NAME="${SEARX_IMAGE_NAME:-${GITHUB_USER:-searx}/searx}"
+        SEARX_IMAGE_NAME="${SEARX_IMAGE_NAME:-${GITHUB_USER:-searxng}/searxng}"
 
         # build Docker image
         build_msg DOCKER "Building image ${SEARX_IMAGE_NAME}:${SEARX_GIT_VERSION}"
@@ -347,7 +356,6 @@ pyenv.install() {
         return 0
     fi
     (   set -e
-        py.clean > /dev/null
         pyenv
     	build_msg PYENV "[install] pip install -e 'searx${PY_SETUP_EXTRAS}'"
     	"${PY_ENV_BIN}/python" -m pip install -e ".${PY_SETUP_EXTRAS}"
@@ -443,7 +451,6 @@ themes.all() {
         node.env
         themes.oscar
         themes.simple
-        themes.bootstrap
     )
     dump_return $?
 }
@@ -462,15 +469,6 @@ themes.simple() {
     dump_return $?
 }
 
-themes.bootstrap() {
-    build_msg LESSC "searx/static/css/bootstrap.min.css"
-    PATH="$(npm bin):$PATH" lessc \
-        --clean-css="--s1 --advanced --compatibility=ie9" \
-        "searx/static/less/bootstrap/bootstrap.less" \
-        "searx/static/css/bootstrap.min.css"
-    dump_return $?
-}
-
 # shellcheck disable=SC2119
 main() {
 

manage.sh

@@ -1,205 +0,0 @@
-#!/bin/sh
-
-export LANG=C
-
-BASE_DIR="$(dirname -- "`readlink -f -- "$0"`")"
-
-cd -- "$BASE_DIR"
-set -e
-
-# subshell
-PYTHONPATH="$BASE_DIR"
-SEARX_DIR="$BASE_DIR/searx"
-ACTION="$1"
-
-. "${BASE_DIR}/utils/brand.env"
-
-#
-# Python
-#
-
-update_packages() {
-    pip install --upgrade pip
-    pip install --upgrade setuptools
-    pip install -Ur "$BASE_DIR/requirements.txt"
-}
-
-update_dev_packages() {
-    update_packages
-    pip install -Ur "$BASE_DIR/requirements-dev.txt"
-}
-
-install_geckodriver() {
-    echo '[!] Checking geckodriver'
-    # TODO : check the current geckodriver version
-    set -e
-    geckodriver -V > /dev/null 2>&1 || NOTFOUND=1
-    set +e
-    if [ -z "$NOTFOUND" ]; then
-        return
-    fi
-    GECKODRIVER_VERSION="v0.28.0"
-    PLATFORM="`python3 -c "import platform; print(platform.system().lower(), platform.architecture()[0])"`"
-    case "$PLATFORM" in
-        "linux 32bit" | "linux2 32bit") ARCH="linux32";;
-        "linux 64bit" | "linux2 64bit") ARCH="linux64";;
-        "windows 32 bit") ARCH="win32";;
-        "windows 64 bit") ARCH="win64";;
-        "mac 64bit") ARCH="macos";;
-    esac
-    GECKODRIVER_URL="https://github.com/mozilla/geckodriver/releases/download/$GECKODRIVER_VERSION/geckodriver-$GECKODRIVER_VERSION-$ARCH.tar.gz";
-
-    if [ -z "$1" ]; then
-        if [ -z "$VIRTUAL_ENV" ]; then
-            printf "geckodriver can't be installed because VIRTUAL_ENV is not set, you should download it from\n  %s" "$GECKODRIVER_URL"
-            exit
-        else
-            GECKODRIVER_DIR="$VIRTUAL_ENV/bin"
-        fi
-    else
-        GECKODRIVER_DIR="$1"
-        mkdir -p -- "$GECKODRIVER_DIR"
-    fi
-
-    printf "Installing %s/geckodriver from\n  %s" "$GECKODRIVER_DIR" "$GECKODRIVER_URL"
-
-    FILE="`mktemp`"
-    wget -qO "$FILE" -- "$GECKODRIVER_URL" && tar xz -C "$GECKODRIVER_DIR" -f "$FILE" geckodriver
-    rm -- "$FILE"
-    chmod 777 -- "$GECKODRIVER_DIR/geckodriver"
-}
-
-locales() {
-    pybabel compile -d "$SEARX_DIR/translations"
-}
-
-
-#
-# Web
-#
-
-npm_path_setup() {
-    which npm || (printf 'Error: npm is not found\n'; exit 1)
-    export PATH="$(npm bin)":$PATH
-}
-
-npm_packages() {
-    npm_path_setup
-
-    echo '[!] install NPM packages'
-    cd -- "$BASE_DIR"
-    npm install less@2.7 less-plugin-clean-css grunt-cli
-
-    echo '[!] install NPM packages for oscar theme'
-    cd -- "$BASE_DIR/searx/static/themes/oscar"
-    npm install
-
-    echo '[!] install NPM packages for simple theme'
-    cd -- "$BASE_DIR/searx/static/themes/simple"
-    npm install
-}
-
-docker_build() {
-    # Check if it is a git repository
-    if [ ! -d .git ]; then
-	echo "This is not Git repository"
-	exit 1
-    fi
-
-    if [ ! -x "$(which git)" ]; then
-	echo "git is not installed"
-	exit 1
-    fi
-
-    if [ ! git remote get-url origin 2> /dev/null ]; then
-	echo "there is no remote origin"
-	exit 1
-    fi
-
-    # This is a git repository
-
-    # "git describe" to get the Docker version (for example : v0.15.0-89-g0585788e)
-    # awk to remove the "v" and the "g"
-    SEARX_GIT_VERSION=$(git describe --match "v[0-9]*\.[0-9]*\.[0-9]*" HEAD 2>/dev/null | awk -F'-' '{OFS="-"; $1=substr($1, 2); if ($3) { $3=substr($3, 2); }  print}')
-
-    # add the suffix "-dirty" if the repository has uncommited change
-    # /!\ HACK for searx/searx: ignore utils/brand.env
-    git update-index -q --refresh
-    if [ ! -z "$(git diff-index --name-only HEAD -- | grep -v 'utils/brand.env')" ]; then
-	SEARX_GIT_VERSION="${SEARX_GIT_VERSION}-dirty"
-    fi
-
-    # Get the last git commit id, will be added to the Searx version (see Dockerfile)
-    VERSION_GITCOMMIT=$(echo $SEARX_GIT_VERSION | cut -d- -f2-4)
-    echo "Last commit : $VERSION_GITCOMMIT"
-
-    # Check consistency between the git tag and the searx/version.py file
-    # /!\ HACK : parse Python file with bash /!\
-    # otherwise it is not possible build the docker image without all Python dependencies ( version.py loads __init__.py )
-    # SEARX_PYTHON_VERSION=$(python3 -c "import six; import searx.version; six.print_(searx.version.VERSION_STRING)")
-    SEARX_PYTHON_VERSION=$(cat searx/version.py | grep "\(VERSION_MAJOR\|VERSION_MINOR\|VERSION_BUILD\) =" | cut -d\= -f2 | sed -e 's/^[[:space:]]*//' | paste -sd "." -)
-    if [ $(echo "$SEARX_GIT_VERSION" | cut -d- -f1) != "$SEARX_PYTHON_VERSION" ]; then
-	echo "Inconsistency between the last git tag and the searx/version.py file"
-	echo "git tag:          $SEARX_GIT_VERSION"
-	echo "searx/version.py: $SEARX_PYTHON_VERSION"
-	exit 1
-    fi
-
-    # define the docker image name
-    GITHUB_USER=$(echo "${GIT_URL}" | sed 's/.*github\.com\/\([^\/]*\).*/\1/')
-    SEARX_IMAGE_NAME="${SEARX_IMAGE_NAME:-${GITHUB_USER:-searxng}/searxng}"
-
-    # build Docker image
-    echo "Building image ${SEARX_IMAGE_NAME}:${SEARX_GIT_VERSION}"
-    sudo docker build \
-         --build-arg GIT_URL="${GIT_URL}" \
-         --build-arg SEARX_GIT_VERSION="${SEARX_GIT_VERSION}" \
-         --build-arg VERSION_GITCOMMIT="${VERSION_GITCOMMIT}" \
-         --build-arg LABEL_DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
-         --build-arg LABEL_VCS_REF=$(git rev-parse HEAD) \
-         --build-arg LABEL_VCS_URL="${GIT_URL}" \
-	 --build-arg TIMESTAMP_SETTINGS=$(git log -1 --format="%cd" --date=unix -- searx/settings.yml) \
-	 --build-arg TIMESTAMP_UWSGI=$(git log -1 --format="%cd" --date=unix -- dockerfiles/uwsgi.ini) \
-         -t ${SEARX_IMAGE_NAME}:latest -t ${SEARX_IMAGE_NAME}:${SEARX_GIT_VERSION} .
-
-    if [ "$1" = "push" ]; then
-	sudo docker push ${SEARX_IMAGE_NAME}:latest
-	sudo docker push ${SEARX_IMAGE_NAME}:${SEARX_GIT_VERSION}
-    fi
-}
-
-#
-# Help
-#
-
-help() {
-    [ -z "$1" ] || printf 'Error: %s\n' "$1"
-    echo "Searx manage.sh help
-
-Commands
-========
-    help                 - This text
-
-    Build requirements
-    ------------------
-    update_packages      - Check & update production dependency changes
-    update_dev_packages  - Check & update development and production dependency changes
-    install_geckodriver  - Download & install geckodriver if not already installed (required for robot_tests)
-    npm_packages         - Download & install npm dependencies
-
-    Build
-    -----
-    locales              - Compile locales
-
-Environment:
-    GIT_URL:          ${GIT_URL}
-    ISSUE_URL:        ${ISSUE_URL}
-    SEARX_URL:        ${SEARX_URL}
-    DOCS_URL:         ${DOCS_URL}
-    PUBLIC_INSTANCES: ${PUBLIC_INSTANCES}
-"
-}
-
-[ "$(command -V "$ACTION" | grep ' function$')" = "" ] \
-    && help "action not found" \
-    || "$ACTION" "$2"

utils/makefile.include

@@ -1,4 +1,5 @@
 # -*- coding: utf-8; mode: makefile-gmake -*-
+# SPDX-License-Identifier: AGPL-3.0-or-later
 
 ifeq (,$(wildcard /.lxcenv.mk))
 PHONY += lxc-activate lxc-purge
@@ -10,60 +11,26 @@ else
 	include /.lxcenv.mk
 endif
 
+PHONY += make-help
 ifeq (,$(wildcard /.lxcenv.mk))
 make-help:
 else
 make-help: lxc-help
 endif
+	@echo  'options:'
 	@echo  '  make V=0|1 [targets] 0 => quiet build (default), 1 => verbose build'
 	@echo  '  make V=2   [targets] 2 => give reason for rebuild of target'
 
-quiet_cmd_common_clean = CLEAN     $@
-      cmd_common_clean = \
-	find . -name '*.orig' -exec rm -f {} +     ;\
-	find . -name '*.rej' -exec rm -f {} +      ;\
-	find . -name '*~' -exec rm -f {} +         ;\
-	find . -name '*.bak' -exec rm -f {} +      ;\
-
-FMT = cat
-ifeq ($(shell which fmt >/dev/null 2>&1; echo $$?), 0)
-FMT = fmt
-endif
-
-# MS-Windows
-#
-# For a minimal *make-environment*, I'am using the gnu-tools from:
-#
-# - GNU MCU Eclipse Windows Build Tools, which brings 'make', 'rm' etc.
-#   https://github.com/gnu-mcu-eclipse/windows-build-tools/releases
-#
-# - git for Windows, which brings 'find', 'grep' etc.
-#   https://git-scm.com/download/win
-
-
-# normpath
-#
-# System-dependent normalization of the path name
-#
-#   usage: $(call normpath,/path/to/file)
-
-normpath = $1
-ifeq ($(OS),Windows_NT)
-  normpath = $(subst /,\,$1)
-endif
-
-
-# stolen from linux/Makefile
-#
-
 ifeq ("$(origin V)", "command line")
-  KBUILD_VERBOSE = $(V)
+  VERBOSE = $(V)
 endif
-ifndef KBUILD_VERBOSE
-  KBUILD_VERBOSE = 0
+ifndef VERBOSE
+  VERBOSE = 0
 endif
 
-ifeq ($(KBUILD_VERBOSE),1)
+export VERBOSE
+
+ifeq ($(VERBOSE),1)
   quiet =
   Q =
 else
@@ -75,14 +42,8 @@ endif
 #
 
 # Convenient variables
-comma   := ,
-quote   := "
-#" this comment is only for emacs highlighting
 squote  := '
 #' this comment is only for emacs highlighting
-empty   :=
-space   := $(empty) $(empty)
-space_escape := _-_SPACE_-_
 
 # Find any prerequisites that is newer than target or that does not exist.
 # PHONY targets skipped in both cases.
@@ -107,7 +68,7 @@ any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
 # (5) No dir/.target.cmd file (used to store command line)
 # (6) No dir/.target.cmd file and target not listed in $(targets)
 #     This is a good hint that there is a bug in the kbuild file
-ifeq ($(KBUILD_VERBOSE),2)
+ifeq ($(VERBOSE),2)
 why =                                                                        \
     $(if $(filter $@, $(PHONY)),- due to target is PHONY,                    \
         $(if $(wildcard $@),                                                 \

utils/makefile.python

@@ -1,269 +0,0 @@
-# -*- coding: utf-8; mode: makefile-gmake -*-
-
-# list of python packages (folders) or modules (files) of this build
-PYOBJECTS ?=
-
-SITE_PYTHON ?=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))site-python
-export PYTHONPATH := $(SITE_PYTHON):$$PYTHONPATH
-export PY_ENV PYDIST PYBUILD
-
-# folder where the python distribution takes place
-PYDIST   = ./$(LXC_ENV_FOLDER)dist
-# folder where the python intermediate build files take place
-PYBUILD  = ./$(LXC_ENV_FOLDER)build
-# python version to use
-PY       ?=3
-# $(PYTHON) points to the python interpreter from the OS!  The python from the
-# OS is needed e.g. to create a virtualenv.  For tasks inside the virtualenv the
-# interpeter from '$(PY_ENV_BIN)/python' is used.
-PYTHON   ?= python$(PY)
-PIP      ?= pip$(PY)
-PIP_INST ?= --user
-
-# https://www.python.org/dev/peps/pep-0508/#extras
-#PY_SETUP_EXTRAS ?= \[develop,test\]
-PY_SETUP_EXTRAS ?=
-
-PYDEBUG  ?= --pdb
-PYLINT_RC ?= .pylintrc
-
-TEST_FOLDER  ?= ./tests
-TEST         ?= .
-
-PY_ENV       = ./$(LXC_ENV_FOLDER)local/py$(PY)
-PY_ENV_BIN   = $(PY_ENV)/bin
-PY_ENV_ACT   = . $(PY_ENV_BIN)/activate
-
-ifeq ($(OS),Windows_NT)
-  PYTHON     = python
-  PY_ENV_BIN = $(PY_ENV)/Scripts
-  PY_ENV_ACT = $(PY_ENV_BIN)/activate
-endif
-
-VTENV_OPTS ?=
-
-python-help::
-	@echo  'makefile.python:'
-	@echo  '  pyenv | pyenv[un]install'
-	@echo  '     build $(PY_ENV) & [un]install python objects'
-	@echo  '  targts using pyenv $(PY_ENV):'
-	@echo  '    pylint    - run pylint *linting*'
-	@echo  '    pytest    - run *tox* test on python objects'
-	@echo  '    pydebug   - run tests within a PDB debug session'
-	@echo  '    pybuild   - build python packages ($(PYDIST) $(PYBUILD))'
-	@echo  '    pyclean   - clean intermediate python objects'
-	@echo  '  targets using system users environment:'
-	@echo  '    py[un]install - [un]install python objects in editable mode'
-	@echo  '    upload-pypi   - upload $(PYDIST)/* files to PyPi'
-	@echo  'options:'
-	@echo  '  make PY=3.7 [targets] => to eval targets with python 3.7 ($(PY))'
-	@echo  '  make PIP_INST=        => to set/unset pip install options ($(PIP_INST))'
-	@echo  '  make TEST=.           => choose test from $(TEST_FOLDER) (default "." runs all)'
-	@echo  '  make DEBUG=           => target "debug": do not invoke PDB on errors'
-	@echo  '  make PY_SETUP_EXTRAS  => also install extras_require from setup.py \[develop,test\]'
-	@echo  '  when using target "pydebug", set breakpoints within py-source by adding::'
-	@echo  '    DEBUG()'
-
-# ------------------------------------------------------------------------------
-# OS requirements
-# ------------------------------------------------------------------------------
-
-PHONY += msg-python-exe python-exe
-msg-python-exe:
-	@echo "\n  $(PYTHON) is required\n\n\
-  Make sure you have $(PYTHON) installed, grab it from\n\
-  https://www.python.org or install it from your package\n\
-  manager. On debian based OS these requirements are\n\
-  installed by::\n\n\
-    sudo -H add-apt-repository ppa:deadsnakes/ppa\n\
-    sudo -H apt update\n\
-    sudo -H apt-get install $(PYTHON) $(PYTHON)-venv\n"
-
-ifeq ($(shell which $(PYTHON) >/dev/null 2>&1; echo $$?), 1)
-python-exe: msg-python-exe
-	$(error The '$(PYTHON)' command was not found)
-else
-python-exe:
-	@:
-endif
-
-msg-pip-exe:
-	@echo "\n  $(PIP) is required\n\n\
-  Make sure you have updated pip installed, grab it from\n\
-  https://pip.pypa.io or install it from your package\n\
-  manager. On debian based OS these requirements are\n\
-  installed by::\n\n\
-    sudo -H apt-get install python$(PY)-pip\n" | $(FMT)
-
-ifeq ($(shell which $(PIP) >/dev/null 2>&1; echo $$?), 1)
-pip-exe: msg-pip-exe
-	$(error The '$(PIP)' command was not found)
-else
-pip-exe:
-	@:
-endif
-
-# ------------------------------------------------------------------------------
-# commands
-# ------------------------------------------------------------------------------
-
-# $2 path to folder with setup.py, this uses pip from the OS
-quiet_cmd_pyinstall = INSTALL   $2
-      cmd_pyinstall = $(PIP) $(PIP_VERBOSE) install $(PIP_INST) -e $2$(PY_SETUP_EXTRAS)
-
-# $2 path to folder with setup.py, this uses pip from pyenv (not OS!)
-quiet_cmd_pyenvinstall = PYENV     install $2
-      cmd_pyenvinstall = \
-	if ! cat $(PY_ENV)/requirements.sha256 2>/dev/null | sha256sum --check --status 2>/dev/null; then \
-		rm -f $(PY_ENV)/requirements.sha256; \
-		$(PY_ENV_BIN)/python -m pip $(PIP_VERBOSE) install -e $2$(PY_SETUP_EXTRAS) &&\
-		sha256sum requirements*.txt > $(PY_ENV)/requirements.sha256 ;\
-	else \
-		echo "PYENV     $2 already installed"; \
-	fi
-
-# Uninstall the package.  Since pip does not uninstall the no longer needed
-# depencies (something like autoremove) the depencies remain.
-
-# $2 package name to uninstall, this uses pip from the OS.
-quiet_cmd_pyuninstall = UNINSTALL $2
-      cmd_pyuninstall = $(PIP) $(PIP_VERBOSE) uninstall --yes $2
-
-# $2 path to folder with setup.py, this uses pip from pyenv (not OS!)
-quiet_cmd_pyenvuninstall = PYENV     uninstall   $2
-      cmd_pyenvuninstall = $(PY_ENV_BIN)/python -m pip $(PIP_VERBOSE) uninstall --yes $2
-
-# $2 path to folder where virtualenv take place
-quiet_cmd_virtualenv  = PYENV     usage: $ source ./$@/bin/activate
-      cmd_virtualenv  = \
-	if [ -d "./$(PY_ENV)" -a -x "./$(PY_ENV_BIN)/python" ]; then \
-		echo "PYENV     using virtualenv from $2"; \
-	else \
-		$(PYTHON) -m venv $(VTENV_OPTS) $2; \
-		$(PY_ENV_BIN)/python -m pip install $(PIP_VERBOSE) -U pip wheel setuptools; \
-		$(PY_ENV_BIN)/python -m pip install $(PIP_VERBOSE) -r requirements.txt; \
-	fi
-
-# $2 path to lint
-quiet_cmd_pylint      = LINT      $@
-      cmd_pylint      = $(PY_ENV_BIN)/python -m pylint -j 0 --rcfile $(PYLINT_RC) $2
-
-quiet_cmd_pytest      = TEST      $@
-      cmd_pytest      = $(PY_ENV_BIN)/python -m tox -vv
-
-# setuptools, pip, easy_install its a mess full of cracks, a documentation hell
-# and broken by design ... all sucks, I really, really hate all this ... aaargh!
-#
-# About python packaging see `Python Packaging Authority`_.  Most of the names
-# here are mapped to ``setup(<name1>=..., <name2>=...)`` arguments in
-# ``setup.py``.  See `Packaging and distributing projects`_ about ``setup(...)``
-# arguments. If this is all new for you, start with `PyPI Quick and Dirty`_.
-#
-# Further read:
-#
-# - pythonwheels_
-# - setuptools_
-# - packaging_
-# - sdist_
-# - installing_
-#
-# .. _`Python Packaging Authority`: https://www.pypa.io
-# .. _`Packaging and distributing projects`: https://packaging.python.org/guides/distributing-packages-using-setuptools/
-# .. _`PyPI Quick and Dirty`: https://hynek.me/articles/sharing-your-labor-of-love-pypi-quick-and-dirty/
-# .. _pythonwheels: https://pythonwheels.com/
-# .. _setuptools: https://setuptools.readthedocs.io/en/latest/setuptools.html
-# .. _packaging: https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-and-distributing-projects
-# .. _sdist: https://packaging.python.org/guides/distributing-packages-using-setuptools/#source-distributions
-# .. _bdist_wheel: https://packaging.python.org/guides/distributing-packages-using-setuptools/#pure-python-wheels
-# .. _installing: https://packaging.python.org/tutorials/installing-packages/
-#
-quiet_cmd_pybuild     = BUILD     $@
-      cmd_pybuild     = $(PY_ENV_BIN)/python setup.py \
-			sdist -d $(PYDIST)  \
-			bdist_wheel --bdist-dir $(PYBUILD) -d $(PYDIST)
-
-quiet_cmd_pyclean     = CLEAN     $@
-# remove 'build' folder since bdist_wheel does not care the --bdist-dir
-      cmd_pyclean     = \
-	rm -rf $(PYDIST) $(PYBUILD) $(PY_ENV) ./.tox *.egg-info     ;\
-	find . -name '*.pyc' -exec rm -f {} +      ;\
-	find . -name '*.pyo' -exec rm -f {} +      ;\
-	find . -name __pycache__ -exec rm -rf {} +
-
-# ------------------------------------------------------------------------------
-# targets
-# ------------------------------------------------------------------------------
-
-# for installation use the pip from the OS!
-PHONY += pyinstall
-pyinstall: pip-exe
-	$(call cmd,pyinstall,.)
-
-PHONY += pyuninstall
-pyuninstall: pip-exe
-	$(call cmd,pyuninstall,$(PYOBJECTS))
-
-# for installation use the pip from PY_ENV (not the OS)!
-PHONY += pyenvinstall
-pyenvinstall: $(PY_ENV)
-	$(call cmd,pyenvinstall,.)
-
-PHONY += pyenvuninstall
-pyenvuninstall: $(PY_ENV)
-	$(call cmd,pyenvuninstall,$(PYOBJECTS))
-
-PHONY += pyclean
-pyclean:
-	$(call cmd,pyclean)
-
-# to build *local* environment, python from the OS is needed!
-pyenv: $(PY_ENV)
-$(PY_ENV): python-exe
-	$(call cmd,virtualenv,$(PY_ENV))
-
-PHONY += pylint-exe
-pylint-exe: $(PY_ENV)
-	@$(PY_ENV_BIN)/python -m pip $(PIP_VERBOSE) install pylint
-
-PHONY += pylint
-pylint: pylint-exe
-	$(call cmd,pylint,$(PYOBJECTS))
-
-PHONY += pybuild
-pybuild: $(PY_ENV)
-	$(call cmd,pybuild)
-
-PHONY += pytest
-pytest: $(PY_ENV)
-	$(call cmd,pytest)
-
-PHONY += pydebug
-# set breakpoint with:
-#    DEBUG()
-# e.g. to run tests in debug mode in emacs use:
-#   'M-x pdb' ... 'make pydebug'
-pydebug: $(PY_ENV)
-	DEBUG=$(DEBUG) $(PY_ENV_BIN)/pytest $(DEBUG) -v $(TEST_FOLDER)/$(TEST)
-
-# runs python interpreter from ./local/py<N>/bin/python
-pyenv-python: pyenvinstall
-	$(PY_ENV_BIN)/python -i
-
-# With 'dependency_links=' setuptools supports dependencies on packages hosted
-# on other reposetories then PyPi, see "Packages Not On PyPI" [1].  The big
-# drawback is, due to security reasons (I don't know where the security gate on
-# PyPi is), this feature is not supported by pip [2]. Thats why an upload to
-# PyPi is required and since uploads via setuptools is not recommended, we have
-# to imstall / use twine ... its really a mess.
-#
-# [1] https://python-packaging.readthedocs.io/en/latest/dependencies.html#packages-not-on-pypi
-# [2] https://github.com/pypa/pip/pull/1519
-
-# https://github.com/pypa/twine
-PHONY += upload-pypi upload-pypi-test
-upload-pypi: pyclean pyenvinstall pybuild
-	@$(PY_ENV_BIN)/twine upload $(PYDIST)/*
-
-upload-pypi-test: pyclean pyenvinstall pybuild
-	@$(PY_ENV_BIN)/twine upload -r testpypi $(PYDIST)/*
-.PHONY: $(PHONY)

utils/makefile.sphinx

@@ -1,199 +0,0 @@
-# -*- coding: utf-8; mode: makefile-gmake -*-
-
-export DOCS_FOLDER DOCS_BUILD DOCS_DIST BOOKS_FOLDER BOOKS_DIST
-
-# You can set these variables from the command line.
-SPHINXOPTS  ?=
-SPHINXBUILD ?= $(PY_ENV_BIN)/sphinx-build
-SPHINX_CONF ?= conf.py
-
-DOCS_FOLDER = ./docs
-DOCS_BUILD  = ./$(LXC_ENV_FOLDER)build/docs
-DOCS_DIST   = ./$(LXC_ENV_FOLDER)dist/docs
-GH_PAGES    ?= build/gh-pages
-
-BOOKS_FOLDER = ./docs
-BOOKS_DIST   = ./$(LXC_ENV_FOLDER)dist/books
-
-ifeq ($(KBUILD_VERBOSE),1)
-  SPHINX_VERBOSE = "-v"
-else
-  SPHINX_VERBOSE =
-endif
-
-
-docs-help:
-	@echo  'makefile.sphinx:'
-	@echo  '  docs-clean	- clean intermediate doc objects'
-	@echo  '  $(GH_PAGES)	- create & upload github pages'
-	@echo  '  sphinx-pdf    - run sphinx latex & pdf targets'
-	@echo  ''
-	@echo  '  books/{name}.html : build only the HTML of document {name}'
-	@echo  '  valid values for books/{name}.html are:'
-	@echo  '    $(BOOKS_HTML)' | $(FMT)
-	@echo  '  books/{name}.pdf : build only the PDF of document {name}'
-	@echo  '  valid values for books/{name}.pdf are:'
-	@echo  '    $(BOOKS_PDF) ' | $(FMT)
-
-# ------------------------------------------------------------------------------
-# requirements
-# ------------------------------------------------------------------------------
-
-PHONY += msg-texlive texlive
-
-ifeq ($(shell which xelatex >/dev/null 2>&1; echo $$?), 1)
-texlive: msg-TeXLive
-	$(error The 'xelatex' command was not found)
-else
-texlive:
-	@:
-endif
-
-msg-texlive:
-	$(Q)echo "\n\
-The TeX/PDF output and the *math* extension require TexLive and latexmk:\n\n\
-  Make sure you have a updated TeXLive with XeTeX engine installed, grab it\n\
-  it from https://www.tug.org/texlive or install it from your package manager.\n\n\
-  Install latexmk from your package manager or visit https://ctan.org/pkg/latexmk\n\n\
-  Sphinx-doc produce (Xe)LaTeX files which might use additional TeX-packages\n\
-  and fonts. To process these LaTeX files, a TexLive installation with the\n\
-  additional packages is required. On debian based OS these requirements\n\
-  are installed by::\n\n\
-    sudo -H apt-get install\n\
-         latexmk\n\
-         texlive-base texlive-xetex texlive-latex-recommended\n\
-         texlive-extra-utils dvipng ttf-dejavu\n"
-
-# ------------------------------------------------------------------------------
-# commands
-# ------------------------------------------------------------------------------
-
-# $2 sphinx builder e.g. "html"
-# $3 path where configuration file (conf.py) is located
-# $4 sourcedir
-# $5 dest subfolder e.g. "man" for man pages at $(DOCS_DIST)/man
-
-quiet_cmd_sphinx = SPHINX    $@ --> file://$(abspath $(DOCS_DIST)/$5)
-      cmd_sphinx = SPHINX_CONF=$(abspath $4/$(SPHINX_CONF))\
-	$(SPHINXBUILD) $(SPHINX_VERBOSE) $(SPHINXOPTS)\
-	-b $2 -c $3 -d $(DOCS_BUILD)/.doctrees $4 $(DOCS_DIST)/$5
-
-quiet_cmd_sphinx_autobuild = SPHINX    $@ --> file://$(abspath $(DOCS_DIST)/$5)
-      cmd_sphinx_autobuild = PATH="$(PY_ENV_BIN):$(PATH)" $(PY_ENV_BIN)/sphinx-autobuild  $(SPHINX_VERBOSE) --open-browser --host 0.0.0.0 $(SPHINXOPTS)\
-	-b $2 -c $3 -d $(DOCS_BUILD)/.doctrees $4 $(DOCS_DIST)/$5
-
-quiet_cmd_sphinx_clean = CLEAN     $@
-      cmd_sphinx_clean = rm -rf $(DOCS_BUILD) $(DOCS_DIST) $(GH_PAGES)/* $(GH_PAGES)/.buildinfo
-
-# ------------------------------------------------------------------------------
-# targets
-# ------------------------------------------------------------------------------
-
-# build PDF of whole documentation in: $(DOCS_DIST)/pdf
-
-PHONY += sphinx-pdf
-sphinx-pdf: sphinx-latex
-	$(Q)cd $(DOCS_BUILD)/latex/; make all-pdf
-	$(Q)mkdir -p $(DOCS_DIST)/pdf
-	$(Q)cp $(DOCS_BUILD)/latex/*.pdf $(DOCS_DIST)/pdf
-	@echo "SPHINX    *.pdf --> file://$(abspath $(DOCS_DIST)/pdf)"
-
-PHONY += sphinx-latex
-sphinx-latex: pyenvinstall texlive
-	$(SPHINXBUILD) $(SPHINX_VERBOSE) $(SPHINXOPTS)\
-	  -b latex \
-	  -c $(DOCS_FOLDER) \
-	  -d $(DOCS_BUILD)/.doctrees \
-	  $(DOCS_FOLDER) \
-	  $(DOCS_BUILD)/latex
-
-# Sphinx projects, we call them *books* (what is more common).  Books are
-# folders under $(BOOKS_FOLDER) containing a conf.py file. The HTML output goes
-# to folder $(BOOKS_DIST)/<name> while PDF is placed (BOOKS_DIST)/<name>/pdf
-
-BOOKS=$(patsubst $(BOOKS_FOLDER)/%/conf.py,books/%,$(wildcard $(BOOKS_FOLDER)/*/conf.py))
-
-# fine grained targets
-BOOKS_HTML  = $(patsubst %,%.html,$(BOOKS))
-BOOKS_CLEAN = $(patsubst %,%.clean,$(BOOKS))
-BOOKS_LATEX = $(patsubst %,%.latex,$(BOOKS))
-BOOKS_PDF   = $(patsubst %,%.pdf,$(BOOKS))
-BOOKS_LIVE  = $(patsubst %,%.live,$(BOOKS))
-
-$(BOOKS_DIST):
-	mkdir -p $(BOOKS_DIST)
-
-PHONY += $(BOOKS_HTML)
-$(BOOKS_HTML): pyenvinstall | $(BOOKS_DIST)
-	SPHINX_CONF=$(patsubst books/%.html,%,$@)/conf.py \
-	$(SPHINXBUILD) $(SPHINX_VERBOSE) $(SPHINXOPTS)\
-	  -b html \
-	  -c $(DOCS_FOLDER) \
-	  -d $(DOCS_BUILD)/books/$(patsubst books/%.html,%,$@)/.doctrees \
-	  $(BOOKS_FOLDER)/$(patsubst books/%.html,%,$@) \
-	  $(BOOKS_DIST)/$(patsubst books/%.html,%,$@)
-	@echo "SPHINX    $@ --> file://$(abspath $(BOOKS_DIST)/$(patsubst books/%.html,%,$@))"
-
-PHONY += $(BOOKS_HTML)
-$(BOOKS_LIVE): pyenvinstall | $(BOOKS_DIST)
-	PATH="$(PY_ENV_BIN):$(PATH)" \
-	SPHINX_CONF=$(patsubst books/%.live,%,$@)/conf.py \
-	$(PY_ENV_BIN)/sphinx-autobuild --poll -B --host 0.0.0.0 --port 8080 $(SPHINX_VERBOSE) $(SPHINXOPTS)\
-	  -b html \
-	  -c $(DOCS_FOLDER) \
-	  -d $(DOCS_BUILD)/books/$(patsubst books/%.live,%,$@)/.doctrees \
-	  $(BOOKS_FOLDER)/$(patsubst books/%.live,%,$@) \
-	  $(BOOKS_DIST)/$(patsubst books/%.live,%,$@)
-
-$(BOOKS_PDF): %.pdf : %.latex
-	$(Q)cd $(DOCS_BUILD)/latex/$(patsubst books/%.pdf,%,$@); make all-pdf
-	$(Q)mkdir -p $(BOOKS_DIST)/$(patsubst books/%.pdf,%,$@)/pdf
-	$(Q)cp -v $(DOCS_BUILD)/latex/$(patsubst books/%.pdf,%,$@)/*.pdf $(BOOKS_DIST)/$(patsubst books/%.pdf,%,$@)/pdf
-	@echo "SPHINX    $@ --> file://$(abspath $(BOOKS_DIST)/$(patsubst books/%.pdf,%,$@))/pdf"
-
-PHONY += $(BOOKS_LATEX)
-$(BOOKS_LATEX): pyenvinstall | $(BOOKS_DIST)
-	SPHINX_CONF=$(patsubst books/%.latex,%,$@)/conf.py \
-	$(SPHINXBUILD) $(SPHINX_VERBOSE) $(SPHINXOPTS)\
-	  -b latex \
-	  -c $(DOCS_FOLDER) \
-	  -d $(DOCS_BUILD)/books/$(patsubst books/%.latex,%,$@)/.doctrees \
-	  $(BOOKS_FOLDER)/$(patsubst books/%.latex,%,$@) \
-	  $(DOCS_BUILD)/latex/$(patsubst books/%.latex,%,$@)
-	@echo "SPHINX    $@ --> file://$(abspath $(DOCS_BUILD)/latex/$(patsubst books/%.latex,%,$@))"
-
-$(BOOKS_CLEAN):
-	$(Q)rm -rf $(BOOKS_DIST)/$(patsubst books/%.clean,%,$@) \
-	       $(DOCS_BUILD)/books/$(patsubst books/%.clean,%,$@) \
-	       $(DOCS_BUILD)/latex/$(patsubst books/%.clean,%,$@)
-
-# github pages
-PHONY += prepare-gh-pages
-prepare-gh-pages:
-	cp -r $(DOCS_DIST)/* $(GH_PAGES)/
-	touch $(GH_PAGES)/.nojekyll
-	echo "<html><head><META http-equiv='refresh' content='0;URL=index.html'></head></html>" > $(GH_PAGES)/404.html
-
-PHONY += gh-pages
-gh-pages: docs-clean docs
-	- git worktree remove -f $(GH_PAGES) || exit 0
-	- git branch -D gh-pages || exit 0
-	git worktree add --no-checkout $(GH_PAGES) master
-	cd $(GH_PAGES); git checkout --orphan gh-pages && git rm -rfq .
-	$(MAKE) prepare-gh-pages
-	cd $(GH_PAGES);\
-		git add --all . ;\
-		git commit -q -m "make gh-pages: from $(shell git config --get remote.origin.url)@$(shell git rev-parse HEAD)" ;\
-		git push -f origin gh-pages
-
-PHONY += ci-gh-pages
-ci-gh-pages: docs-clean docs
-	rm -Rf $(GH_PAGES)
-	mkdir -p $(GH_PAGES)
-	$(MAKE) prepare-gh-pages
-
-PHONY += docs-clean
-docs-clean: $(BOOKS_CLEAN)
-	$(call cmd,sphinx_clean)
-
-.PHONY: $(PHONY)

utils/searx.sh

@@ -481,7 +481,7 @@ pyenv_is_available() {
 create_pyenv() {
     rst_title "Create virtualenv (python)" section
     echo
-    if [[ ! -f "${SEARX_SRC}/manage.sh" ]]; then
+    if [[ ! -f "${SEARX_SRC}/manage" ]]; then
         err_msg "to create pyenv for searx, searx has to be cloned first"
         return 42
     fi

utils/site-python/sphinx_build_tools.py

@@ -1,48 +0,0 @@
-# -*- coding: utf-8; mode: python -*-
-"""Implement some sphinx-build tools.
-
-"""
-
-import os
-import sys
-from sphinx.util.pycompat import execfile_
-
-# ------------------------------------------------------------------------------
-def load_sphinx_config(namespace):
-# ------------------------------------------------------------------------------
-
-    u"""Load an additional configuration file into *namespace*.
-
-    The name of the configuration file is taken from the environment
-    ``SPHINX_CONF``. The external configuration file extends (or overwrites) the
-    configuration values from the origin ``conf.py``.  With this you are able to
-    maintain *build themes*.  To your docs/conf.py add::
-
-        from sphinx_build_tools import load_sphinx_config
-        ...
-
-        # Since loadConfig overwrites settings from the global namespace, it has to be
-        # the last statement in the conf.py file
-
-        load_sphinx_config(globals())
-
-    """
-
-    config_file = os.environ.get("SPHINX_CONF", None)
-    if (config_file is not None
-        and os.path.normpath(namespace["__file__"]) != os.path.normpath(config_file) ):
-        config_file = os.path.abspath(config_file)
-
-        if os.path.isfile(config_file):
-            sys.stdout.write(
-                "load additional sphinx-config: %s\n"
-                % config_file)
-            config = namespace.copy()
-            config['__file__'] = config_file
-            execfile_(config_file, config)
-            del config['__file__']
-            namespace.update(config)
-        else:
-            sys.stderr.write(
-                "WARNING: additional sphinx-config not found: %s\n"
-                % config_file)