docmachine-containers/Makefile

265 lines
6.9 KiB
Makefile
Raw Normal View History

2018-04-20 15:27:59 +00:00
#!/usr/bin/make -f
2021-12-06 13:59:18 +00:00
## System-wide installation of python/node ?
SYSTEM_INSTALL=0
## Configure this part if you wish to
DEPLOY_REPO=
DEPLOY_OPTS=
## Input directories
SLIDES_DIR=slides
DOCS_DIR=docs
IMAGES_DIR=images
BUILD_DIR=_build
2021-07-23 14:15:53 +00:00
CACHE_DIR=_cache
## Internal directories
CACHE_SLIDES_DIR=$(CACHE_DIR)/slides
## Output directories
BUILD_SLIDES_DIR=$(BUILD_DIR)/slides
BUILD_DOCS_DIR=$(BUILD_DIR)/docs
BUILD_IMAGES_DIR=images
2021-11-25 15:59:13 +00:00
BUILD_VERSION=v$(shell date "+%Y%m%d-%H%M")
2021-07-23 14:15:53 +00:00
## Ports
2020-04-19 10:44:17 +00:00
DOCS_PORT=5100
SLIDES_PORT=5200
2018-04-20 15:27:59 +00:00
## Find .md slides
2021-07-23 14:15:53 +00:00
SLIDES_MDPP=$(shell find $(SLIDES_DIR) \( -name '*.mdpp' ! -name '_*' \))
SLIDES_MDPP_MD=$(patsubst $(SLIDES_DIR)/%.mdpp,$(CACHE_SLIDES_DIR)/%.mdpp.md,$(SLIDES_MDPP))
SLIDES_MDPP_MD_PDF=$(patsubst $(CACHE_SLIDES_DIR)/%.mdpp.md,$(BUILD_SLIDES_DIR)/%.pdf,$(SLIDES_MDPP_MD))
SLIDES_MD=$(shell find $(SLIDES_DIR) \( -name '*.md' ! -name '_*' \)) $(SLIDES_MDPP_MD)
SLIDES_MD_PDF=$(patsubst $(SLIDES_DIR)/%.md,$(BUILD_SLIDES_DIR)/%.pdf,$(SLIDES_MD))
SLIDES_MD_ALL=$(SLIDES_MDPP_MD) $(SLIDES_MD)
SLIDES_PDF_ALL=$(SLIDES_MDPP_MD_PDF) $(SLIDES_MD_PDF)
2018-04-20 15:27:59 +00:00
## Find .uml graphs
DOCS_IMAGES_UML=$(shell find $(IMAGES_DIR) \( -name '*.uml' ! -name '_*' \))
DOCS_IMAGES_UML_SVG=$(patsubst $(IMAGES_DIR)/%.uml,$(BUILD_IMAGES_DIR)/%.uml.svg,$(DOCS_IMAGES_UML))
## Find .dot graphs
DOCS_IMAGES_DOT=$(shell find $(IMAGES_DIR) \( -name '*.dot' ! -name '_*' \))
DOCS_IMAGES_DOT_SVG=$(patsubst $(IMAGES_DIR)/%.dot,$(BUILD_IMAGES_DIR)/%.dot.svg,$(DOCS_IMAGES_DOT))
2020-09-03 09:30:31 +00:00
## Find .circo graphs
DOCS_IMAGES_CIRCO=$(shell find $(IMAGES_DIR) \( -name '*.circo' ! -name '_*' \))
DOCS_IMAGES_CIRCO_SVG=$(patsubst $(IMAGES_DIR)/%.circo,$(BUILD_IMAGES_DIR)/%.circo.svg,$(DOCS_IMAGES_CIRCO))
## Find .ora images
DOCS_IMAGES_ORA=$(shell find $(IMAGES_DIR) \( -name '*.ora' ! -name '_*' \))
DOCS_IMAGES_ORA_PNG=$(patsubst $(IMAGES_DIR)/%.ora,$(BUILD_IMAGES_DIR)/%.ora.png,$(DOCS_IMAGES_ORA))
## Merge all lists
DOCS_IMAGES_SVG=$(DOCS_IMAGES_DOT_SVG) $(DOCS_IMAGES_CIRCO_SVG) $(DOCS_IMAGES_UML_SVG)
DOCS_IMAGES_PNG=$(DOCS_IMAGES_ORA_PNG)
2020-09-03 09:30:31 +00:00
all: help
2018-04-20 15:27:59 +00:00
##
## Install prerequisites
##
2018-04-20 15:27:59 +00:00
prepare: prepare-slides prepare-docs ## install prerequisites
2018-04-20 15:27:59 +00:00
prepare-slides: ## install prerequisites for PDF slides only
npm install
npx browserslist@latest --update-db
2018-04-20 15:27:59 +00:00
prepare-docs: ## install prerequisites for static docs site only
2021-12-15 22:34:09 +00:00
pipenv install
# if [ "$(SYSTEM_INSTALL)" -eq 1 ]; then \
# pipenv install --deploy --system ; \
#else \
# pipenv install ; \
#fi
2018-04-20 15:27:59 +00:00
.PHONY: prepare prepare-slides prepare-docs
2018-04-20 15:27:59 +00:00
images: $(DOCS_IMAGES_SVG) $(DOCS_IMAGES_PNG) ## build images
@echo "Source:"
@echo " ora: $(DOCS_IMAGES_ORA)"
@echo " uml: $(DOCS_IMAGES_UML)"
@echo " dot: $(DOCS_IMAGES_DOT)"
@echo " circo: $(DOCS_IMAGES_CIRCO)"
@echo "Built: $(DOCS_IMAGES_SVG) $(DOCS_IMAGES_PNG)"
2020-09-03 09:30:31 +00:00
.PHONY: images
%.ora.png: %.ora
TMPDIR="$$(mktemp -d)" \
&& unzip -q $< -d "$$TMPDIR" mergedimage.png \
&& touch "$$TMPDIR/mergedimage.png" \
&& mv "$$TMPDIR/mergedimage.png" $@
%.uml.svg: %.uml
plantuml -pipe -tsvg < $< > $@
2020-09-03 09:30:31 +00:00
%.dot.svg: %.dot
dot -Tsvg $< > $@
%.circo.svg: %.circo
circo -Tsvg $< > $@
2018-04-20 15:27:59 +00:00
2021-07-23 14:15:53 +00:00
$(CACHE_SLIDES_DIR)/%.mdpp.md: $(SLIDES_DIR)/%.mdpp
mkdir -p "$$(dirname "$@")"
m4 -d -I$(SLIDES_DIR) -I$(CACHE_SLIDES_DIR) $< > $@ \
|| ( rm -f $@ && exit 1 )
.marp/theme.css:
cd .marp && $(MAKE) theme.css
watch: ## run development server
pipenv run honcho start
2018-04-20 15:27:59 +00:00
watch-tocupdate-internal:
while inotifywait -q -e move -e modify -e create -e attrib -e delete -e moved_to -r docs ; do \
sleep 2 ; \
$(MAKE) images ; \
done
2020-09-03 09:30:31 +00:00
watch-docs-internal:
pipenv run mkdocs serve --dev-addr 0.0.0.0:$(DOCS_PORT)
watch-slides-internal: .marp/theme.css
PORT=$(SLIDES_PORT) \
npx marp \
--engine $$(pwd)/.marp/engine.js \
--html \
--theme $$(pwd)/.marp/theme.css \
-w $(SLIDES_DIR) \
-s
2018-04-20 15:27:59 +00:00
2020-09-03 09:30:31 +00:00
watch-slides: ## run development server for PDF slides
pipenv run honcho start slides
watch-docs: ## run development server for static docs site
2020-09-03 09:30:31 +00:00
pipenv run honcho start docs toc
2018-04-20 15:27:59 +00:00
serve: watch
serve-slides: watch-slides
serve-docs: watch-docs
2018-04-20 15:27:59 +00:00
2020-09-03 09:30:31 +00:00
.PHONY: watch watch-slides watch-docs watch-slides-internal watch-docs-internal serve serve-docs serve-slides
2018-04-20 15:27:59 +00:00
2021-12-06 11:22:19 +00:00
$(BUILD_SLIDES_DIR)/%.pdf: $(CACHE_SLIDES_DIR)/%.mdpp.md | $(BUILD_SLIDES_DIR) .marp/theme.css
2021-07-23 14:15:53 +00:00
npx marp --allow-local-files \
--engine $$(pwd)/.marp/engine.js \
--html \
--theme $$(pwd)/.marp/theme.css \
$< \
-o $@
2018-04-20 15:27:59 +00:00
2021-12-06 11:22:19 +00:00
$(BUILD_SLIDES_DIR)/%.pdf: $(SLIDES_DIR)/%.md | $(BUILD_SLIDES_DIR) .marp/theme.css
npx marp --allow-local-files \
2020-09-03 09:30:31 +00:00
--engine $$(pwd)/.marp/engine.js \
--html \
2020-09-29 14:41:52 +00:00
--theme $$(pwd)/.marp/theme.css \
$< \
-o $@
2018-04-20 15:27:59 +00:00
2021-07-23 14:15:53 +00:00
$(BUILD_SLIDES_DIR):
mkdir -p $(BUILD_SLIDES_DIR)
2018-04-20 15:27:59 +00:00
##
## Build final documents
##
## slides => PDF
## docs => static web site
##
2018-04-20 15:27:59 +00:00
2021-12-21 15:39:51 +00:00
build: build-pdf build-html ## build all documents as PDF and HTML files
2018-04-20 15:27:59 +00:00
build-pdf: build-docs-pdf build-slides-pdf ## build both docs and slides as PDF files
2021-12-21 15:39:51 +00:00
build-html: build-docs-html build-slides-html ## build both docs and slides as HTML files
2021-12-21 15:39:51 +00:00
build-docs: build-docs-pdf build-docs-html ## build only docs as PDF and HTML
build-slides: build-slides-pdf build-slides-html ## build only slides as PDF and HTML
2021-12-21 15:39:51 +00:00
build-slides-pdf: $(SLIDES_PDF_ALL) $(SLIDES_MD_ALL) ## build PDF slides only
2021-07-23 14:15:53 +00:00
build-slides-html: $(SLIDES_HTML_ALL) ## build HTML slides only
2021-07-23 14:15:53 +00:00
merge-slides: $(SLIDES_MDPP_MD) $(SLIDES_MD_ALL)
2021-12-21 15:39:51 +00:00
build-docs-pdf:
mkdir -p $(BUILD_DOCS_DIR)
rm -f $(BUILD_DOCS_DIR)/combined.pdf
PYTHONUTF8=1 \
ENABLE_PDF_EXPORT=1 \
pipenv run mkdocs build \
--site-dir $(BUILD_DOCS_DIR)
pdftk \
$$(find $(BUILD_DOCS_DIR) -name *.pdf -not -name index.pdf |sort ) \
cat output $(BUILD_DOCS_DIR)/combined.pdf
build-docs-html: ## build static docs site only
mkdir -p $(BUILD_DOCS_DIR)
pipenv run mkdocs build \
--site-dir $(BUILD_DOCS_DIR)
.PHONY: build build-slides
deploy-docs: ## deploy static docs site to github
git push $(DEPLOY_REPO)
pipenv run mkdocs gh-deploy $(DEPLOY_OPTS)
help: ## print this help
@echo "Usage: make <target>"
@echo ""
@echo "With one of following targets:"
@echo ""
@awk 'BEGIN {FS = ":.*?## "} \
/^[a-zA-Z_-]+:.*?## / \
{ sub("\\\\n",sprintf("\n%22c"," "), $$2); \
printf("\033[36m%-20s\033[0m %s\n", $$1, $$2); \
}' $(MAKEFILE_LIST)
@echo ""
##
## Clean
##
clean: clean-slides clean-docs # remove generated documents
clean-slides:
rm -fr $(BUILD_SLIDES_DIR) # remove generated PDF slides
clean-docs:
rm -fr $(BUILD_DOCS_DIR) # remove generated static docs site
.PHONY: clean clean-slides clean-docs
2018-04-20 15:27:59 +00:00
##
## Utilities
##
fixme:
@egrep --color -rni '(fixme)' $(DOCS_DIR) $(SLIDES_DIR)
.PHONY: fixme
2021-11-25 15:59:13 +00:00
2022-01-30 14:54:43 +00:00
docker-build: ## build docker image
docker build \
--file docker/Dockerfile \
--tag glenux/teaching-boilerplate:$(BUILD_VERSION) \
.
docker tag \
glenux/teaching-boilerplate:$(BUILD_VERSION) \
glenux/teaching-boilerplate:latest
2021-11-25 15:59:13 +00:00
2022-01-30 14:54:43 +00:00
docker-push: ## push docker image
2021-11-25 17:44:26 +00:00
env docker push glenux/teaching-boilerplate:latest
2021-11-25 15:59:13 +00:00
2022-01-30 14:54:43 +00:00
docker-pull: ## download docker image
2021-11-25 17:44:26 +00:00
env docker pull glenux/teaching-boilerplate:latest