Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Yannic opened this issue Dec 29, 2019 · 2 comments
Open
Labels
enhancement New feature or request P3 We're not considering to work on this, but happy to review a PR. (No assignee)

Comments

@Yannic
Copy link
Collaborator

Yannic commented Dec 29, 2019

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 Yannic added the question Further information is requested label Dec 29, 2019
@sgammon
Copy link

sgammon commented Sep 11, 2020

@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.

@cdickson-sum
Copy link

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

@comius comius added P3 We're not considering to work on this, but happy to review a PR. (No assignee) enhancement New feature or request and removed question Further information is requested labels Feb 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P3 We're not considering to work on this, but happy to review a PR. (No assignee)
Projects
None yet
Development

No branches or pull requests

4 participants