Skip to content

Commit

Permalink
feat: generate documentation for proto files (#1064)
Browse files Browse the repository at this point in the history
  • Loading branch information
amirvalhalla authored Feb 2, 2024
1 parent ffd84e6 commit 12c4d27
Show file tree
Hide file tree
Showing 5 changed files with 4,910 additions and 4 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ devtools:
go install google.golang.org/protobuf/cmd/[email protected]
go install google.golang.org/grpc/cmd/[email protected]
go install github.com/NathanBaulch/[email protected]
go install github.com/pseudomuto/protoc-gen-doc/cmd/[email protected]
go install github.com/bufbuild/buf/cmd/[email protected]
go install mvdan.cc/gofumpt@latest
go install github.com/rakyll/[email protected]
Expand Down
8 changes: 8 additions & 0 deletions www/grpc/buf/buf.gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ plugins:
out: ../gen/go
opt:
- paths=source_relative
- name: doc
out: ../gen/docs
opt:
- markdown,index.md
- name: doc
out: ../gen/docs
opt:
- html,index.html
- name: go-grpc
out: ../gen/go
opt: paths=source_relative,require_unimplemented_servers=false
Expand Down
Loading

0 comments on commit 12c4d27

Please sign in to comment.