k3s/hack/gen-swagger-doc
Chao Xu 358221f9fd Don't update api-reference docs if the only changes are the timestamps 2015-11-06 11:37:22 -08:00
..
example-output typofix - https://github.com/vlajos/misspell_fixer 2015-08-08 22:31:48 +01:00
Dockerfile Don't update api-reference docs if the only changes are the timestamps 2015-11-06 11:37:22 -08:00
README.md
build.gradle
gen-swagger-docs.sh Don't update api-reference docs if the only changes are the timestamps 2015-11-06 11:37:22 -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