Skip to content

Commit 5814ff8

Browse files
author
Cheng Pan
committed
Add makefile to generate doc using docker images
Develop can use `make doc` command to generate doc without installing extra rust dependencies.
1 parent 0daa379 commit 5814ff8

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# The example references the latest .yaml file directly in the source repository,
22
# therefore we don't need the copy in the generated documentation.
33
docs/example
4+
5+
*.swp

Makefile

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Copyright 2018 The Kubernetes Authors.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
doc:
16+
docker run --rm -v $(CURDIR):/data -u $(id -u):$(id -g) -it chengpan/mdbook:0.2.1 mdbook build ./book

0 commit comments

Comments
 (0)