Skip to content

Commit

Permalink
Generate KFService api docs (kserve#381)
Browse files Browse the repository at this point in the history
* Generate api docs

* Add link to readme

* Rename html to README.md
  • Loading branch information
yuzisun authored and k8s-ci-robot committed Sep 30, 2019
1 parent 5ce6920 commit e4bbdce
Show file tree
Hide file tree
Showing 4 changed files with 1,296 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,7 @@ docker-build-executor: test

docker-push-executor:
docker push ${EXECUTOR_IMG}

apidocs:
docker build -f docs/apis/Dockerfile --rm -t apidocs-gen . && \
docker run -it --rm -v ${PWD}/docs/apis:/go/gen-crd-api-reference-docs/apidocs apidocs-gen
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ KFServing encapsulates the complexity of autoscaling, networking, health checkin
* Join our [Working Group](https://groups.google.com/forum/#!forum/kfserving) for meeting invites and discussion.
* [Read the Docs](/docs).
* [Examples](./docs/samples).
* [API Docs](./docs/apis/README.md)
* [Roadmap](/ROADMAP.md).
* [KFServing 101 Slides](https://drive.google.com/file/d/16oqz6dhY5BR0u74pi9mDThU97Np__AFb/view).
* [KFServing 101 Tech Talk](https://www.youtube.com/watch?v=hGIvlFADMhU).
Expand Down
14 changes: 14 additions & 0 deletions docs/apis/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
FROM golang:1.13.1

RUN apt-get update && apt-get -y upgrade && apt-get -y install git

RUN git clone https://github.com/ahmetb/gen-crd-api-reference-docs

WORKDIR gen-crd-api-reference-docs

RUN go build

VOLUME /go/gen-crd-api-reference-docs/apidocs

ENTRYPOINT ["./gen-crd-api-reference-docs"]
CMD ["-config", "./example-config.json", "-api-dir", "github.com/kubeflow/kfserving/pkg/apis/serving/v1alpha2", "-out-file", "./apidocs/README.md"]
Loading

0 comments on commit e4bbdce

Please sign in to comment.