66 lines
1.8 KiB
Makefile
66 lines
1.8 KiB
Makefile
#######
|
|
# This Makefile contains all targets related to the documentation
|
|
#######
|
|
|
|
DOCS_VERIFY_SKIP ?= false
|
|
DOCS_LINT_SKIP ?= false
|
|
|
|
TRAEFIK_DOCS_BUILD_IMAGE ?= traefik-docs
|
|
TRAEFIK_DOCS_CHECK_IMAGE ?= $(TRAEFIK_DOCS_BUILD_IMAGE)-check
|
|
|
|
SITE_DIR := $(CURDIR)/site
|
|
|
|
DOCKER_RUN_DOC_PORT := 8000
|
|
DOCKER_RUN_DOC_MOUNTS := -v $(CURDIR):/mkdocs
|
|
DOCKER_RUN_DOC_OPTS := --rm $(DOCKER_RUN_DOC_MOUNTS) -p $(DOCKER_RUN_DOC_PORT):8000
|
|
|
|
# Default: generates the documentation into $(SITE_DIR)
|
|
.PHONY: docs
|
|
docs: docs-clean docs-image docs-lint docs-build docs-verify
|
|
|
|
# Writer Mode: build and serve docs on http://localhost:8000 with livereload
|
|
.PHONY: docs-serve
|
|
docs-serve: docs-image
|
|
docker run $(DOCKER_RUN_DOC_OPTS) $(TRAEFIK_DOCS_BUILD_IMAGE) mkdocs serve
|
|
|
|
## Pull image for doc building
|
|
.PHONY: docs-pull-images
|
|
docs-pull-images:
|
|
grep --no-filename -E '^FROM' ./*.Dockerfile \
|
|
| awk '{print $$2}' \
|
|
| sort \
|
|
| uniq \
|
|
| xargs -P 6 -n 1 docker pull
|
|
|
|
# Utilities Targets for each step
|
|
.PHONY: docs-image
|
|
docs-image:
|
|
docker build -t $(TRAEFIK_DOCS_BUILD_IMAGE) -f docs.Dockerfile ./
|
|
|
|
.PHONY: docs-build
|
|
docs-build: docs-image
|
|
docker run $(DOCKER_RUN_DOC_OPTS) $(TRAEFIK_DOCS_BUILD_IMAGE) sh -c "mkdocs build \
|
|
&& chown -R $(shell id -u):$(shell id -g) ./site"
|
|
|
|
.PHONY: docs-verify
|
|
docs-verify: docs-build
|
|
ifneq ("$(DOCS_VERIFY_SKIP)", "true")
|
|
docker build -t $(TRAEFIK_DOCS_CHECK_IMAGE) -f check.Dockerfile ./
|
|
docker run --rm -v $(CURDIR):/app $(TRAEFIK_DOCS_CHECK_IMAGE) /verify.sh
|
|
else
|
|
echo "DOCS_VERIFY_SKIP is true: no verification done."
|
|
endif
|
|
|
|
.PHONY: docs-lint
|
|
docs-lint:
|
|
ifneq ("$(DOCS_LINT_SKIP)", "true")
|
|
docker build -t $(TRAEFIK_DOCS_CHECK_IMAGE) -f check.Dockerfile ./
|
|
docker run --rm -v $(CURDIR):/app $(TRAEFIK_DOCS_CHECK_IMAGE) /lint.sh
|
|
else
|
|
echo "DOCS_LINT_SKIP is true: no linting done."
|
|
endif
|
|
|
|
.PHONY: docs-clean
|
|
docs-clean:
|
|
rm -rf $(SITE_DIR)
|