git.iko.soy/searx
on master help sign in
[fix] buildprocess of the docs by adding sphinx-doc-prebuilds target

The sphinx-doc-prebuilds is the single point of definition for prerequisites each doc build needs BTW: remove $(LXC_ENV_FOLDER) offset from BOOKS_FOLDER and DOCS_FOLDER path. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

commit15924bcb67680933f6ef71ddc3cd910fed62fbbd authorMarkus Heiser <markus.heiser@darmarit.de> dateThu 18 Jun 2020, 18:44 (6 years ago) parent4f7a6c0
2 files changed+17−12
compare with master
unifiedsplit
Makefile+10−7 utils/makefile.sphinx+7−5
Makefile+10−7
@@ -77,19 +77,22 @@ run: buildenv pyenvinstall
7777# docs
7878# ----
7979
80+sphinx-doc-prebuilds:: buildenv pyenvinstall prebuild-includes
81+
8082PHONY += docs
81−docs: buildenv pyenvinstall sphinx-doc prebuild-includes
83+docs: sphinx-doc-prebuilds sphinx-doc
8284 $(call cmd,sphinx,html,docs,docs)
8385
84−PHONY += docs-live prebuild-includes
85−docs-live: buildenv pyenvinstall sphinx-live prebuild-includes
86+PHONY += docs-live
87+docs-live: sphinx-doc-prebuilds sphinx-live
8688 $(call cmd,sphinx_autobuild,html,docs,docs)
8789
90+PHONY += prebuild-includes
8891prebuild-includes:
89− @mkdir -p $(DOCS_BUILD)/includes
90− @./utils/searx.sh doc | cat > $(DOCS_BUILD)/includes/searx.rst
91− @./utils/filtron.sh doc | cat > $(DOCS_BUILD)/includes/filtron.rst
92− @./utils/morty.sh doc | cat > $(DOCS_BUILD)/includes/morty.rst
92+ $(Q)mkdir -p $(DOCS_BUILD)/includes
93+ $(Q)./utils/searx.sh doc | cat > $(DOCS_BUILD)/includes/searx.rst
94+ $(Q)./utils/filtron.sh doc | cat > $(DOCS_BUILD)/includes/filtron.rst
95+ $(Q)./utils/morty.sh doc | cat > $(DOCS_BUILD)/includes/morty.rst
9396
9497
9598$(GH_PAGES)::
utils/makefile.sphinx+7−5
@@ -7,12 +7,12 @@ SPHINXOPTS ?=
77SPHINXBUILD ?= $(PY_ENV_BIN)/sphinx-build
88SPHINX_CONF ?= conf.py
99
10−DOCS_FOLDER = ./$(LXC_ENV_FOLDER)docs
10+DOCS_FOLDER = ./docs
1111DOCS_BUILD = ./$(LXC_ENV_FOLDER)build/docs
1212DOCS_DIST = ./$(LXC_ENV_FOLDER)dist/docs
1313GH_PAGES ?= gh-pages
1414
15−BOOKS_FOLDER = ./$(LXC_ENV_FOLDER)docs
15+BOOKS_FOLDER = ./docs
1616BOOKS_DIST = ./$(LXC_ENV_FOLDER)dist/books
1717
1818ifeq ($(KBUILD_VERBOSE),1)
@@ -56,11 +56,13 @@ docs-help:
5656# requirements
5757# ------------------------------------------------------------------------------
5858
59−sphinx-doc: $(PY_ENV)
59+sphinx-doc-prebuilds:: $(PY_ENV)
60+
61+sphinx-doc: sphinx-doc-prebuilds
6062 @echo "PYENV installing Sphinx$(SPHINXVERS)"
6163 $(Q)$(PY_ENV_BIN)/pip install $(PIP_VERBOSE) 'Sphinx$(SPHINXVERS)'
6264
63−sphinx-live: $(PY_ENV)
65+sphinx-live: sphinx-doc-prebuilds
6466 @echo "PYENV installing Sphinx$(SPHINXVERS)"
6567 $(Q)$(PY_ENV_BIN)/pip install $(PIP_VERBOSE) 'Sphinx$(SPHINXVERS)' sphinx-autobuild
6668
@@ -115,7 +117,7 @@ quiet_cmd_sphinx_clean = CLEAN $@
115117# targets
116118# ------------------------------------------------------------------------------
117119
118−# build PDF of whole documentation in: $(DOCS_DIST)/pdf
120+# build PDF of whole documentation in: $(DOCS_DIST)/pdf
119121
120122PHONY += sphinx-pdf
121123sphinx-pdf: sphinx-latex