From 86e79488aab3ff434c6682a9464ba2eee49158e9 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 15 Mar 2020 17:01:36 +0100 Subject: LXC: utils/makefile.lxc (inital) add /.lxcenv.mk to contaiiners Get LXC environment when building make targets. Signed-off-by: Markus Heiser --- utils/makefile.sphinx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'utils/makefile.sphinx') diff --git a/utils/makefile.sphinx b/utils/makefile.sphinx index 2c1922fc9..4926bb53a 100644 --- a/utils/makefile.sphinx +++ b/utils/makefile.sphinx @@ -1,17 +1,19 @@ # -*- coding: utf-8; mode: makefile-gmake -*- +export DOCS_FOLDER DOCS_BUILD DOCS_DIST BOOKS_FOLDER BOOKS_DIST + # You can set these variables from the command line. SPHINXOPTS ?= SPHINXBUILD ?= $(PY_ENV_BIN)/sphinx-build SPHINX_CONF ?= conf.py -DOCS_FOLDER ?= docs -DOCS_BUILD ?= build/docs -DOCS_DIST ?= dist/docs +DOCS_FOLDER = docs$(LXC_ENV_FOLDER) +DOCS_BUILD = build/docs$(LXC_ENV_FOLDER) +DOCS_DIST = dist/docs$(LXC_ENV_FOLDER) GH_PAGES ?= gh-pages -BOOKS_FOLDER ?= docs -BOOKS_DIST ?= dist/books +BOOKS_FOLDER = docs$(LXC_ENV_FOLDER) +BOOKS_DIST = dist/books$(LXC_ENV_FOLDER) ifeq ($(KBUILD_VERBOSE),1) SPHINX_VERBOSE = "-v" -- cgit v1.2.3 From 2d956696e94e5639db6e12648442989919c48c22 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sat, 21 Mar 2020 18:45:38 +0100 Subject: docs: building (PDF) books / build user book BTW: cleaned up Makefile target help Signed-off-by: Markus Heiser --- utils/makefile.sphinx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'utils/makefile.sphinx') diff --git a/utils/makefile.sphinx b/utils/makefile.sphinx index 4926bb53a..8a1f6b76b 100644 --- a/utils/makefile.sphinx +++ b/utils/makefile.sphinx @@ -156,7 +156,7 @@ $(BOOKS_HTML): sphinx-doc | $(BOOKS_DIST) -b html \ -c $(DOCS_FOLDER) \ -d $(DOCS_BUILD)/books/$(patsubst books/%.html,%,$@)/.doctrees \ - $(patsubst books/%.html,%,$@) \ + $(BOOKS_FOLDER)/$(patsubst books/%.html,%,$@) \ $(BOOKS_DIST)/$(patsubst books/%.html,%,$@) @echo "SPHINX $@ --> file://$(abspath $(BOOKS_DIST)/$(patsubst books/%.html,%,$@))" @@ -168,7 +168,7 @@ $(BOOKS_LIVE): sphinx-live | $(BOOKS_DIST) -b html \ -c $(DOCS_FOLDER) \ -d $(DOCS_BUILD)/books/$(patsubst books/%.live,%,$@)/.doctrees \ - $(patsubst books/%.live,%,$@) \ + $(BOOKS_FOLDER)/$(patsubst books/%.live,%,$@) \ $(BOOKS_DIST)/$(patsubst books/%.live,%,$@) $(BOOKS_PDF): %.pdf : %.latex @@ -184,7 +184,7 @@ $(BOOKS_LATEX): sphinx-doc | $(BOOKS_DIST) -b latex \ -c $(DOCS_FOLDER) \ -d $(DOCS_BUILD)/books/$(patsubst books/%.latex,%,$@)/.doctrees \ - $(patsubst books/%.latex,%,$@) \ + $(BOOKS_FOLDER)/$(patsubst books/%.latex,%,$@) \ $(DOCS_BUILD)/latex/$(patsubst books/%.latex,%,$@) @echo "SPHINX $@ --> file://$(abspath $(DOCS_BUILD)/latex/$(patsubst books/%.latex,%,$@))" -- cgit v1.2.3 From baf1ffd1fa4923f3bd105f0d8daac4a9527bdc50 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 23 Mar 2020 18:05:46 +0100 Subject: LXC: set LXC_ENV_FOLDER=lxc/$(shell hostname)/ Signed-off-by: Markus Heiser --- utils/makefile.sphinx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'utils/makefile.sphinx') diff --git a/utils/makefile.sphinx b/utils/makefile.sphinx index 8a1f6b76b..fd4c3a6f1 100644 --- a/utils/makefile.sphinx +++ b/utils/makefile.sphinx @@ -7,13 +7,13 @@ SPHINXOPTS ?= SPHINXBUILD ?= $(PY_ENV_BIN)/sphinx-build SPHINX_CONF ?= conf.py -DOCS_FOLDER = docs$(LXC_ENV_FOLDER) -DOCS_BUILD = build/docs$(LXC_ENV_FOLDER) -DOCS_DIST = dist/docs$(LXC_ENV_FOLDER) +DOCS_FOLDER = ./$(LXC_ENV_FOLDER)docs +DOCS_BUILD = ./$(LXC_ENV_FOLDER)build/docs +DOCS_DIST = ./$(LXC_ENV_FOLDER)dist/docs GH_PAGES ?= gh-pages -BOOKS_FOLDER = docs$(LXC_ENV_FOLDER) -BOOKS_DIST = dist/books$(LXC_ENV_FOLDER) +BOOKS_FOLDER = ./$(LXC_ENV_FOLDER)docs +BOOKS_DIST = ./$(LXC_ENV_FOLDER)dist/books ifeq ($(KBUILD_VERBOSE),1) SPHINX_VERBOSE = "-v" -- cgit v1.2.3 From 15924bcb67680933f6ef71ddc3cd910fed62fbbd Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 18 Jun 2020 18:44:22 +0200 Subject: [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 --- utils/makefile.sphinx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'utils/makefile.sphinx') diff --git a/utils/makefile.sphinx b/utils/makefile.sphinx index fd4c3a6f1..1b0f42ccb 100644 --- a/utils/makefile.sphinx +++ b/utils/makefile.sphinx @@ -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 @@ -115,7 +117,7 @@ quiet_cmd_sphinx_clean = CLEAN $@ # targets # ------------------------------------------------------------------------------ -# build PDF of whole documentation in: $(DOCS_DIST)/pdf +# build PDF of whole documentation in: $(DOCS_DIST)/pdf PHONY += sphinx-pdf sphinx-pdf: sphinx-latex -- cgit v1.2.3