Dockerfile and related scritps for a container that generates docs for API types
This commit is contained in:
18
hack/gen-swagger-doc/README.md
Normal file
18
hack/gen-swagger-doc/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
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.
|
||||
|
||||
|
||||
[]()
|
Reference in New Issue
Block a user