diff --git a/Dockerfile.dev b/Dockerfile.dev index c8656725..78049226 100644 --- a/Dockerfile.dev +++ b/Dockerfile.dev @@ -5,5 +5,24 @@ COPY scripts/devtools.sh /opt/devtools.sh RUN set -e -x \ && /opt/devtools.sh +# install mkdocs +RUN set -ex \ + && buildDeps=' \ + build-essential \ + python-dev \ + ' \ + && apt-get update && apt-get install -y --no-install-recommends \ + $buildDeps \ + python2.7 \ + python-pip \ + && pip install --upgrade \ + pip \ + 'Markdown>=2.6.9' \ + 'mkdocs>=0.16.3' \ + 'mkdocs-material>=1.10.1' \ + 'markdown-include>=0.5.1' \ + && apt-get purge -y --auto-remove $buildDeps \ + && rm -rf /var/lib/apt/lists/* + ENV CGO_ENABLED 0 ENV GOPATH /go:/yaml diff --git a/Makefile b/Makefile index 88e7d347..951dd422 100644 --- a/Makefile +++ b/Makefile @@ -37,15 +37,17 @@ veryclean: clean ## prefix before other make targets to run in your local dev environment local: | quiet @$(eval DOCKRUN= ) + @mkdir -p tmp + @touch tmp/dev_image_id quiet: # this is silly but shuts up 'Nothing to be done for `local`' @: prepare: tmp/dev_image_id tmp/dev_image_id: Dockerfile.dev scripts/devtools.sh - @[ -z "${DOCKRUN}" ] || mkdir -p tmp - @[ -z "${DOCKRUN}" ] || docker rmi -f ${DEV_IMAGE} > /dev/null 2>&1 || true - @[ -z "${DOCKRUN}" ] || docker build -t ${DEV_IMAGE} -f Dockerfile.dev . - @[ -z "${DOCKRUN}" ] || docker inspect -f "{{ .ID }}" ${DEV_IMAGE} > tmp/dev_image_id + @mkdir -p tmp + @docker rmi -f ${DEV_IMAGE} > /dev/null 2>&1 || true + @docker build -t ${DEV_IMAGE} -f Dockerfile.dev . + @docker inspect -f "{{ .ID }}" ${DEV_IMAGE} > tmp/dev_image_id # ---------------------------------------------- # build @@ -99,6 +101,12 @@ cover: check @find cover -type d -exec chmod 755 {} \; || : @find cover -type f -exec chmod 644 {} \; || : +.PHONY: build-docs +build-docs: prepare mkdocs.yml mkdocs/* + ${DOCKRUN} mkdocs build + @find docs -type d -exec chmod 755 {} \; || : + @find docs -type f -exec chmod 644 {} \; || : + # ---------------------------------------------- # utilities diff --git a/docs/404.html b/docs/404.html index 89ac2090..7aadb98a 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1,17 +1,18 @@ - +
+ - + @@ -19,10 +20,10 @@ - + - + @@ -60,10 +61,11 @@