Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 15924bcb authored by Markus Heiser's avatar Markus Heiser
Browse files

[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: default avatarMarkus Heiser <markus.heiser@darmarit.de>
parent 4f7a6c09

Makefile

+10 −7
Original line number Diff line number Diff line
@@ -77,19 +77,22 @@ run: buildenv pyenvinstall 
# docs

# ----



sphinx-doc-prebuilds:: buildenv pyenvinstall prebuild-includes



PHONY += docs

docs:  buildenv pyenvinstall sphinx-doc prebuild-includes

docs:  sphinx-doc-prebuilds sphinx-doc

	$(call cmd,sphinx,html,docs,docs)



PHONY += docs-live prebuild-includes

docs-live:  buildenv pyenvinstall sphinx-live prebuild-includes

PHONY += docs-live

docs-live:  sphinx-doc-prebuilds sphinx-live

	$(call cmd,sphinx_autobuild,html,docs,docs)



PHONY += prebuild-includes

prebuild-includes:

	@mkdir -p $(DOCS_BUILD)/includes

	@./utils/searx.sh doc | cat > $(DOCS_BUILD)/includes/searx.rst

	@./utils/filtron.sh doc | cat > $(DOCS_BUILD)/includes/filtron.rst

	@./utils/morty.sh doc | cat > $(DOCS_BUILD)/includes/morty.rst

	$(Q)mkdir -p $(DOCS_BUILD)/includes

	$(Q)./utils/searx.sh doc | cat > $(DOCS_BUILD)/includes/searx.rst

	$(Q)./utils/filtron.sh doc | cat > $(DOCS_BUILD)/includes/filtron.rst

	$(Q)./utils/morty.sh doc | cat > $(DOCS_BUILD)/includes/morty.rst





$(GH_PAGES)::

utils/makefile.sphinx

+7 −5
Original line number Diff line number Diff line
@@ -7,12 +7,12 @@ SPHINXOPTS ?= 
SPHINXBUILD ?= $(PY_ENV_BIN)/sphinx-build

SPHINX_CONF ?= conf.py



DOCS_FOLDER = ./$(LXC_ENV_FOLDER)docs

DOCS_FOLDER = ./docs

DOCS_BUILD  = ./$(LXC_ENV_FOLDER)build/docs

DOCS_DIST   = ./$(LXC_ENV_FOLDER)dist/docs

GH_PAGES    ?= gh-pages



BOOKS_FOLDER = ./$(LXC_ENV_FOLDER)docs

BOOKS_FOLDER = ./docs

BOOKS_DIST   = ./$(LXC_ENV_FOLDER)dist/books



ifeq ($(KBUILD_VERBOSE),1)
@@ -56,11 +56,13 @@ docs-help: 
# requirements

# ------------------------------------------------------------------------------



sphinx-doc: $(PY_ENV)

sphinx-doc-prebuilds:: $(PY_ENV)



sphinx-doc: sphinx-doc-prebuilds

	@echo "PYENV     installing Sphinx$(SPHINXVERS)"

	$(Q)$(PY_ENV_BIN)/pip install $(PIP_VERBOSE) 'Sphinx$(SPHINXVERS)'



sphinx-live: $(PY_ENV)

sphinx-live: sphinx-doc-prebuilds

	@echo "PYENV     installing Sphinx$(SPHINXVERS)"

	$(Q)$(PY_ENV_BIN)/pip install $(PIP_VERBOSE) 'Sphinx$(SPHINXVERS)' sphinx-autobuild