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
Chao Xu f816491fdb fix the title of the operations.html 2015-10-02 17:20:27 -07:00
..
example-output typofix - https://github.com/vlajos/misspell_fixer 2015-08-08 22:31:48 +01:00
Dockerfile Dockerfile and related scritps for a container that generates docs for API types 2015-07-17 15:46:54 -07: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 fix the title of the operations.html 2015-10-02 17:20:27 -07:00
run-gen-swagger-docs.sh fix the title of the operations.html 2015-10-02 17:20:27 -07: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