From ef85943e06a1ac0083d8a7c76a08e885f2e27d90 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 12 Dec 2019 12:10:32 +0100 Subject: 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 --- Makefile | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'Makefile') 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 # ---- -- cgit v1.2.3 From af2cae6d1d71859e867a9fbc5da604ef6a898794 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 4 Dec 2019 16:48:36 +0100 Subject: doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx - add sphinx extensions - patch documentation to make use of These modules help to simplify the reST markup of external references. BTW it helps to write more readable reST and form custom brands. Signed-off-by: Markus Heiser --- Makefile | 3 +++ 1 file changed, 3 insertions(+) (limited to 'Makefile') diff --git a/Makefile b/Makefile index dae8fce31..b4eb14ba7 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,8 @@ # -*- coding: utf-8; mode: makefile-gmake -*- +export GIT_URL=https://github.com/asciimoo/searx +export SEARX_URL=https://searx.me + PYOBJECTS = searx DOC = docs PY_SETUP_EXTRAS ?= \[test\] -- cgit v1.2.3 From 0011890043a65b318a32134ab4029f3c74bc07ee Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 12 Dec 2019 14:15:41 +0100 Subject: gh-pages - build docs & deploy on gh-pages branch Signed-off-by: Markus Heiser --- Makefile | 1 + 1 file changed, 1 insertion(+) (limited to 'Makefile') diff --git a/Makefile b/Makefile index b4eb14ba7..28b7c58ce 100644 --- a/Makefile +++ b/Makefile @@ -21,6 +21,7 @@ help: @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 '' -- cgit v1.2.3 From 121f6964602d7717185df12c9ecd69387aad1d2d Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 13 Dec 2019 12:58:46 +0100 Subject: Makefile: gh-pages: keep history of gh-branch intact (don't drop) Signed-off-by: Markus Heiser --- Makefile | 3 +++ 1 file changed, 3 insertions(+) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 28b7c58ce..cf5e5e636 100644 --- a/Makefile +++ b/Makefile @@ -2,6 +2,7 @@ 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 @@ -59,6 +60,8 @@ PHONY += docs-live docs-live: pyenvinstall sphinx-live $(call cmd,sphinx_autobuild,html,docs,docs) +$(GH_PAGES):: + @echo "doc available at --> $(DOCS_URL)" # test # ---- -- cgit v1.2.3 From 02d5173fb23dfcba02634e2765bf7fd91e3d0437 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 13 Dec 2019 16:08:34 +0100 Subject: Makefile: remove trailing '/' from DOCS_URL Signed-off-by: Markus Heiser --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index cf5e5e636..b69202ba2 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ export GIT_URL=https://github.com/asciimoo/searx export SEARX_URL=https://searx.me -export DOCS_URL=https://asciimoo.github.io/searx/ +export DOCS_URL=https://asciimoo.github.io/searx PYOBJECTS = searx DOC = docs -- cgit v1.2.3 From f09459b98ae877d7dfd40d85c0edf058c65913d5 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Wed, 18 Dec 2019 16:11:05 +0100 Subject: doc: describe Makefile targets 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 --- Makefile | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'Makefile') diff --git a/Makefile b/Makefile index b69202ba2..f35b86c41 100644 --- a/Makefile +++ b/Makefile @@ -8,6 +8,9 @@ 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 @@ -23,6 +26,7 @@ help: @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 '' -- cgit v1.2.3