github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/hack/gen-swagger-doc
History
laushinka 7ef585be22 Spelling fixes inspired by github.com/client9/misspell 2016-02-18 06:58:05 +07:00
..
example-output Spelling fixes inspired by github.com/client9/misspell 2016-02-18 06:58:05 +07:00
Dockerfile Add boilerplate checks for Dockerfiles 2016-02-03 18:35:26 -05:00
README.md Dockerfile and related scritps for a container that generates docs for API types 2015-07-17 15:46:54 -07:00
build.gradle Dockerfile and related scritps for a container that generates docs for API types 2015-07-17 15:46:54 -07:00
gen-swagger-docs.sh refacotr update-api-reference-docs.sh 2016-02-10 16:46:59 -08:00

README.md

This folder contains the sources needed to build the gen-swagger-doc container.

To build the container image,

$ sudo docker build -t gcr.io/google_containers/gen-swagger-docs:v1 .

To generate the html docs,

$ ./run-gen-swagger-docs.sh <API version> <absolute output path, default to PWD>

The generated definitions.html and operations.html will be stored in output paths.

Analytics