Cleanup build of documentation and update to mkdocs 1.1 (#5163)
This commit is contained in:
parent
4a63609c3e
commit
a589b4357b
4 changed files with 7 additions and 55 deletions
5
Makefile
5
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
|
-t ingress-nginx/mkdocs images/mkdocs
|
||||||
@docker run --rm -it -p 3000:3000 -v ${PWD}:/docs ingress-nginx/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
|
.PHONY: misspell
|
||||||
misspell: check-go-version ## Check for spelling errors.
|
misspell: check-go-version ## Check for spelling errors.
|
||||||
@go get github.com/client9/misspell/cmd/misspell
|
@go get github.com/client9/misspell/cmd/misspell
|
||||||
|
|
|
@ -12,29 +12,14 @@
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
FROM alpine:3.11
|
FROM squidfunk/mkdocs-material:4.6.3
|
||||||
|
|
||||||
RUN apk add --no-cache \
|
RUN apk add --no-cache curl \
|
||||||
bash \
|
&& curl -sSL https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/requirements-docs.txt -o requirements.txt \
|
||||||
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 \
|
|
||||||
&& pip install -U -r requirements.txt
|
&& pip install -U -r requirements.txt
|
||||||
|
|
||||||
WORKDIR /docs
|
WORKDIR /docs
|
||||||
|
|
||||||
EXPOSE 3000
|
EXPOSE 3000
|
||||||
|
|
||||||
COPY entrypoint.sh /
|
ENTRYPOINT ["mkdocs", "serve", "--dev-addr=0.0.0.0:3000", "--livereload"]
|
||||||
|
|
||||||
ENTRYPOINT ["/entrypoint.sh"]
|
|
||||||
|
|
|
@ -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
|
|
|
@ -1,4 +1,4 @@
|
||||||
mkdocs-material~=4.6.2
|
mkdocs-material==4.6.3
|
||||||
mkdocs~=1.0.4
|
mkdocs==1.1
|
||||||
pymdown-extensions~=6.3
|
pymdown-extensions==6.3
|
||||||
pygments~=2.5.2
|
pygments~=2.5.2
|
||||||
|
|
Loading…
Reference in a new issue