# Makefile for MkDocs documentation
#

# You can set these variables from the command line.
MKDOCS       = mkdocs
BUILDDIR     = site

# User-friendly check for mkdocs
ifeq ($(shell which $(MKDOCS) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(MKDOCS)' command was not found. Make sure you have MkDocs installed with 'pip install mkdocs mkdocs-material', then make sure the mkdocs executable is in your PATH.)
endif

.PHONY: help clean html build serve

help:
	@echo "Please use \`make <target>' where <target> is one of"
	@echo "  html       to build the documentation (same as build)"
	@echo "  build      to build the documentation"
	@echo "  serve      to start the development server"
	@echo "  clean      to clean the build directory"

clean:
	rm -rf $(BUILDDIR)/*

html: build

build:
	$(MKDOCS) build
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/."

serve:
	$(MKDOCS) serve
	@echo "Development server started at http://127.0.0.1:8000/"