Automatic documentation generation for gRPC API

.gitignore

@@ -173,3 +173,5 @@ dmypy.json
 # Pyre type checker
 .pyre/
 .vscode
+
+sdk/python/docs/html

Makefile

@@ -47,6 +47,9 @@ clean-html:
 	rm -rf 	$(PROJECT_ROOT)/dist
 
 build-html:
+	rm -rf $(PROJECT_ROOT)/dist/
 	mkdir -p $(PROJECT_ROOT)/dist/python
+	mkdir -p $(PROJECT_ROOT)/dist/grpc
+	cd 	$(PROJECT_ROOT)/protos && $(MAKE) gen-docs
 	cd 	$(PROJECT_ROOT)/sdk/python/docs && $(MAKE) html
 	cp -r $(PROJECT_ROOT)/sdk/python/docs/html/* $(PROJECT_ROOT)/dist/python

go.mod

@@ -5,25 +5,26 @@ require (
 	github.com/Masterminds/semver v1.5.0 // indirect
 	github.com/Masterminds/sprig v2.22.0+incompatible // indirect
 	github.com/ghodss/yaml v1.0.0
+	github.com/gogo/protobuf v1.3.1 // indirect
 	github.com/golang/mock v1.2.0
 	github.com/golang/protobuf v1.3.2
-	github.com/google/go-cmp v0.2.0
-	github.com/google/uuid v1.1.1 // indirect
+	github.com/google/go-cmp v0.3.0
 	github.com/huandu/xstrings v1.2.0 // indirect
-	github.com/imdario/mergo v0.3.8 // indirect
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
 	github.com/lyft/protoc-gen-validate v0.1.0 // indirect
 	github.com/mitchellh/copystructure v1.0.0 // indirect
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/mwitkow/go-proto-validators v0.2.0 // indirect
 	github.com/pseudomuto/protoc-gen-doc v1.3.0 // indirect
 	github.com/pseudomuto/protokit v0.2.0 // indirect
-	github.com/spf13/cobra v0.0.3
-	github.com/spf13/viper v1.3.2
+	github.com/spf13/cobra v0.0.4
+	github.com/spf13/viper v1.4.0
 	github.com/woop/protoc-gen-doc v1.3.0 // indirect
-	golang.org/x/net v0.0.0-20180826012351-8a410e7b638d
-	google.golang.org/grpc v1.19.1
-	gopkg.in/yaml.v2 v2.2.2
+	golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553
+	google.golang.org/grpc v1.23.0
+	gopkg.in/russross/blackfriday.v2 v2.0.0 // indirect
+	gopkg.in/yaml.v2 v2.2.4
+	istio.io/gogo-genproto v0.0.0-20191212213402-78a529a42cd8 // indirect
+	istio.io/tools v0.0.0-20191228030621-c4eb6a11039c // indirect
 )
 
 go 1.13

protos/Makefile

@@ -12,5 +12,22 @@ gen-python:
 	@$(foreach dir,$(dirs),python -m grpc_tools.protoc -I. --python_out=../sdk/python/ --mypy_out=../sdk/python/ feast/$(dir)/*.proto;)
 	@$(foreach dir,$(service_dirs),python -m grpc_tools.protoc -I. --grpc_python_out=../sdk/python/ feast/$(dir)/*.proto;)
 
+install-dependencies-docs:
+	mkdir -p $$HOME/bin
+	mkdir -p $$HOME/include
+	go get github.com/golang/protobuf/proto && \
+	go get gopkg.in/russross/blackfriday.v2 && \
+	cd $$(mktemp -d) && \
+	git clone https://github.com/istio/tools/ && \
+	cd tools/cmd/protoc-gen-docs && \
+	go build && \
+	cp protoc-gen-docs $$HOME/bin && \
+	cd $$HOME && curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.11.2/protoc-3.11.2-linux-x86_64.zip && \
+	unzip protoc-3.11.2-linux-x86_64.zip -d protoc3 && \
+	mv protoc3/bin/* $$HOME/bin/ && \
+	chmod +x $$HOME/bin/protoc && \
+	mv protoc3/include/* $$HOME/include
+
 gen-docs:
-	protoc --doc_out=../docs/api/ --doc_opt=../docs/assets/protoc-gen-doc-markdown.tmpl,proto.md feast/core/*.proto feast/serving/*.proto feast/storage/*.proto feast/types/*.proto;
+	protoc --docs_out=../dist/grpc feast/*/*.proto || \
+	$(MAKE) install-dependencies-docs && PATH=$$HOME/bin:$$PATH protoc -I $$HOME/include/ -I . --docs_out=../dist/grpc feast/*/*.proto