Makefile

GNUMAKEFLAGS := --no-builtins --no-builtin-variables
.SUFFIXES:

ifeq ($(OS),Windows_NT)
--which := where
--null := nul
RM := rmdir /s /q
else
--which := which
--null ?= /dev/null
RM := rm -rf
endif

POETRY ?= $(shell $(--which) poetry 2> $(--null))

ifeq ($(POETRY),)
$(error Could not find the `poetry` command. \
	Please make sure you have installed poetry, \
	and that it is on your system's PATH environment variable. \
	If you don't have poetry installed, \
	please visit https://python-poetry.org \
	for instructions on its installation)
endif

SRCDIR ?= $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
OUTDIR ?= $(join $(SRCDIR),_site)
ARCHIVE ?= cps-docs.tar
SPHINXOPTS ?=

venv := $(notdir $(realpath $(shell $(POETRY) env info --path 2> $(--null))))

archive.flags += --create --verbose
archive.flags += --exclude=.[^/]*
archive.flags += --file=$(ARCHIVE)
archive.flags += --directory=$(OUTDIR)
ifneq ($(OS),Windows_NT)
archive.flags += --mode=a+rw
endif

setup.flags += --with=docs

build.flags += $(if $(BUILDER),-b $(BUILDER),-b html)
build.flags += $(if $(LOGFILE),-w "$(LOGFILE)")
build.flags += $(if $(NOCOLOR),,--color)
build.flags += $(SPHINXOPTS)

.PHONY: all setup html clean.venv clean.cache clean purge archive
.PHONY: setup/fast html/fast archive/fast

all: html

setup: setup/fast
setup/fast:
	$(POETRY) check
	$(POETRY) install $(setup.flags)

html: setup html/fast
html/fast:
	$(POETRY) run sphinx-build $(build.flags) "$(SRCDIR)" "$(OUTDIR)"

clean.venv:
	$(if $(venv),$(POETRY) env remove "$(venv)",@echo "Nothing to do")

clean.cache:
	$(RM) "$(join $(OUTDIR),.doctrees)"

clean:
	$(RM) "$(OUTDIR)"

purge: clean.venv clean

archive: html archive/fast
archive/fast:
	tar $(archive.flags) .