rules_proto icon indicating copy to clipboard operation
rules_proto copied to clipboard

Should rules_proto provide a rule to generate docs from .proto files

Open Yannic opened this issue 5 years ago • 2 comments

Generating docs for Protobuf message/services is a common use-case, so it would be nice to provide a way to generate them. I'm a bit on the edge of whether this rule should be part of rules_proto or be part of another repo.

What do people think?

Yannic avatar Dec 29 '19 15:12 Yannic

@Yannic my vote would be yes. I just tried to get protoc-gen-doc to work with rules_proto, to accomplish this very feature, but I've been unable to figure out how to easily invoke it (i.e. proto_lang_toolchain seems meant for other purposes, so I've resorted to macros, which are tough w.r.t. transitive dependencies)

I think it would be awesome if documentation could be generated directly from a proto_library. The requirements for that invocation are largely the same: access to dependencies (including transitive), source access, etc.

sgammon avatar Sep 11 '20 21:09 sgammon

@Yannic my vote would also be yes. My experience is largely the same as @sgammon.

cdickson-sum avatar Sep 22 '20 12:09 cdickson-sum