mirror of
https://github.com/searxng/searxng.git
synced 2024-11-26 12:51:02 +00:00
f09459b98a
With the aim to simplify development cycles, started with PR #1756 a Makefile based boilerplate was added. This patch adds the missing developer documentation. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
89 lines
2 KiB
Makefile
89 lines
2 KiB
Makefile
# -*- coding: utf-8; mode: makefile-gmake -*-
|
|
|
|
export GIT_URL=https://github.com/asciimoo/searx
|
|
export SEARX_URL=https://searx.me
|
|
export DOCS_URL=https://asciimoo.github.io/searx
|
|
|
|
PYOBJECTS = searx
|
|
DOC = docs
|
|
PY_SETUP_EXTRAS ?= \[test\]
|
|
|
|
PYDIST=./dist/py
|
|
PYBUILD=./build/py
|
|
|
|
include utils/makefile.include
|
|
include utils/makefile.python
|
|
include utils/makefile.sphinx
|
|
|
|
all: clean install
|
|
|
|
PHONY += help
|
|
help:
|
|
@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 ''
|
|
@$(MAKE) -s -f utils/makefile.include make-help
|
|
@echo ''
|
|
@$(MAKE) -s -f utils/makefile.python python-help
|
|
|
|
PHONY += install
|
|
install: pyenvinstall
|
|
|
|
PHONY += uninstall
|
|
uninstall: pyenvuninstall
|
|
|
|
PHONY += clean
|
|
clean: pyclean
|
|
$(call cmd,common_clean)
|
|
|
|
PHONY += run
|
|
run: pyenvinstall
|
|
$(Q) ( \
|
|
sed -i -e "s/debug : False/debug : True/g" ./searx/settings.yml ; \
|
|
sleep 2 ; \
|
|
xdg-open http://127.0.0.1:8888/ ; \
|
|
sleep 3 ; \
|
|
sed -i -e "s/debug : True/debug : False/g" ./searx/settings.yml ; \
|
|
) &
|
|
$(PY_ENV)/bin/python ./searx/webapp.py
|
|
|
|
# docs
|
|
# ----
|
|
|
|
PHONY += docs
|
|
docs: pyenvinstall sphinx-doc
|
|
$(call cmd,sphinx,html,docs,docs)
|
|
|
|
PHONY += docs-live
|
|
docs-live: pyenvinstall sphinx-live
|
|
$(call cmd,sphinx_autobuild,html,docs,docs)
|
|
|
|
$(GH_PAGES)::
|
|
@echo "doc available at --> $(DOCS_URL)"
|
|
|
|
# test
|
|
# ----
|
|
|
|
PHONY += test test.pylint test.pep8 test.unit test.robot
|
|
|
|
# TODO: balance linting with pylint
|
|
test: test.pep8 test.unit test.robot
|
|
- make pylint
|
|
|
|
test.pep8: pyenvinstall
|
|
$(PY_ENV_ACT); ./manage.sh pep8_check
|
|
|
|
test.unit: pyenvinstall
|
|
$(PY_ENV_ACT); ./manage.sh unit_tests
|
|
|
|
test.robot: pyenvinstall
|
|
$(PY_ENV_ACT); ./manage.sh install_geckodriver
|
|
$(PY_ENV_ACT); ./manage.sh robot_tests
|
|
|
|
.PHONY: $(PHONY)
|