summaryrefslogtreecommitdiff
path: root/Makefile
diff options
context:
space:
mode:
authorAdam Tauber <asciimoo@gmail.com>2019-12-16 11:41:49 +0000
committerGitHub <noreply@github.com>2019-12-16 11:41:49 +0000
commitfb6ff5afcb1ec5771bc149fee25d186198aa7607 (patch)
tree93d214f4039bea8aa42d8713bc3c2b35d38465ad /Makefile
parent3f93fe04d8c43191cc3bff51c9add1c35728c789 (diff)
parent02d5173fb23dfcba02634e2765bf7fd91e3d0437 (diff)
Merge pull request #1767 from return42/docs
move reST source from gh-pages to master
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile23
1 files changed, 23 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 77ffe489f..b69202ba2 100644
--- a/Makefile
+++ b/Makefile
@@ -1,19 +1,28 @@
# -*- 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\]
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 ''
@$(MAKE) -s -f utils/makefile.include make-help
@echo ''
@@ -40,6 +49,20 @@ 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)
+
+$(GH_PAGES)::
+ @echo "doc available at --> $(DOCS_URL)"
+
# test
# ----