summaryrefslogtreecommitdiff
path: root/Makefile
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2019-12-12 12:10:32 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2019-12-12 12:10:32 +0100
commitef85943e06a1ac0083d8a7c76a08e885f2e27d90 (patch)
treec4b69b771955faddd85106862880407a02c33abf /Makefile
parentbb2b9b8da4d5e548b88c1fae4faf2af1cb225008 (diff)
downloadsearxng-ef85943e06a1ac0083d8a7c76a08e885f2e27d90.tar.gz
searxng-ef85943e06a1ac0083d8a7c76a08e885f2e27d90.zip
Makefile: add documentation build targets docs & docs-live
BTW: - add build & dist folder to .gitignore - justify indentation of build messages (makefile.python) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile16
1 files changed, 16 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 77ffe489f..dae8fce31 100644
--- a/Makefile
+++ b/Makefile
@@ -1,16 +1,20 @@
# -*- coding: utf-8; mode: makefile-gmake -*-
PYOBJECTS = searx
+DOC = docs
PY_SETUP_EXTRAS ?= \[test\]
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)'
@@ -40,6 +44,18 @@ run: pyenvinstall
) &
$(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)
+
+
# test
# ----