From a589b4357b330b7f1207ad7546a82b2ea2e60284 Mon Sep 17 00:00:00 2001 From: Manuel Alejandro de Brito Fontes Date: Mon, 24 Feb 2020 20:10:07 -0300 Subject: [PATCH] Cleanup build of documentation and update to mkdocs 1.1 (#5163) --- Makefile | 5 ----- images/mkdocs/Dockerfile | 23 ++++------------------- images/mkdocs/entrypoint.sh | 28 ---------------------------- requirements-docs.txt | 6 +++--- 4 files changed, 7 insertions(+), 55 deletions(-) delete mode 100755 images/mkdocs/entrypoint.sh diff --git a/Makefile b/Makefile index 7b3b129d3..60bd000f3 100644 --- a/Makefile +++ b/Makefile @@ -252,11 +252,6 @@ live-docs: ## Build and launch a local copy of the documentation website in http -t ingress-nginx/mkdocs images/mkdocs @docker run --rm -it -p 3000:3000 -v ${PWD}:/docs ingress-nginx/mkdocs -.PHONY: build-docs -build-docs: ## Build documentation (output in ./site directory). - @docker build --pull -t ingress-nginx/mkdocs images/mkdocs - @docker run --rm -v ${PWD}:/docs ingress-nginx/mkdocs build - .PHONY: misspell misspell: check-go-version ## Check for spelling errors. @go get github.com/client9/misspell/cmd/misspell diff --git a/images/mkdocs/Dockerfile b/images/mkdocs/Dockerfile index c171b3cb5..caab02da1 100644 --- a/images/mkdocs/Dockerfile +++ b/images/mkdocs/Dockerfile @@ -12,29 +12,14 @@ # See the License for the specific language governing permissions and # limitations under the License. -FROM alpine:3.11 +FROM squidfunk/mkdocs-material:4.6.3 -RUN apk add --no-cache \ - bash \ - git \ - git-fast-import \ - openssh \ - python3 \ - python3-dev \ - curl \ - && python3 -m ensurepip \ - && rm -r /usr/lib/python*/ensurepip \ - && pip3 install --upgrade pip setuptools \ - && rm -r /root/.cache \ - && rm -rf /var/cache/apk/* - -RUN curl -sSL https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/requirements-docs.txt -o requirements.txt \ +RUN apk add --no-cache curl \ + && curl -sSL https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/requirements-docs.txt -o requirements.txt \ && pip install -U -r requirements.txt WORKDIR /docs EXPOSE 3000 -COPY entrypoint.sh / - -ENTRYPOINT ["/entrypoint.sh"] +ENTRYPOINT ["mkdocs", "serve", "--dev-addr=0.0.0.0:3000", "--livereload"] diff --git a/images/mkdocs/entrypoint.sh b/images/mkdocs/entrypoint.sh deleted file mode 100755 index dc87db8bc..000000000 --- a/images/mkdocs/entrypoint.sh +++ /dev/null @@ -1,28 +0,0 @@ -#!/bin/bash - -# Copyright 2018 The Kubernetes Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -set -o errexit -set -o pipefail - -CMD=$1 - -if [ "$CMD" == "build" ]; -then - mkdocs build - exit 0; -fi - -mkdocs serve --dev-addr=0.0.0.0:3000 --livereload diff --git a/requirements-docs.txt b/requirements-docs.txt index 5bed1b15a..55f8de7e6 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,4 +1,4 @@ -mkdocs-material~=4.6.2 -mkdocs~=1.0.4 -pymdown-extensions~=6.3 +mkdocs-material==4.6.3 +mkdocs==1.1 +pymdown-extensions==6.3 pygments~=2.5.2