github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-04 02:37:36 +00:00
Code Issues Projects Releases Wiki Activity

Add a gendocs pre-submit hook.

Browse Source
This commit is contained in:
Brendan Burns
2015-01-14 21:27:13 -08:00
parent 88c68e0349
commit 718a563b1f
3 changed files with 105 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/devel/development.md
View File

@@ -238,16 +238,9 @@ git fetch upstream
git rebase upstream/master
```
## Regenerating the API documentation
## Regenerating the CLI documentation
```
cd kubernetes/api
sudo docker build -t kubernetes/raml2html .
sudo docker run --name="docgen" kubernetes/raml2html
sudo docker cp docgen:/data/kubernetes.html .
hack/run-gendocs.sh
```
View the API documentation using htmlpreview (works on your fork, too):
```
http://htmlpreview.github.io/?https://github.com/GoogleCloudPlatform/kubernetes/blob/master/api/kubernetes.html
```