Skip to content

Commit 365cab9

Browse files
Taskfile: use buf to generate docs
1 parent add53b5 commit 365cab9

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

Diff for: Taskfile.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,8 @@ tasks:
243243
protoc:docs:
244244
desc: Generate docs for protobuf definitions
245245
cmds:
246-
- '{{ default "protoc" .PROTOC_BINARY }} --doc_out=./docs/rpc --doc_opt=markdown,commands.md --proto_path=rpc ./rpc/cc/arduino/cli/commands/v1/*.proto'
246+
- |
247+
buf generate --template buf.doc.gen.yaml
247248
248249
docs:include-configuration-json-schema:
249250
desc: Copy configuration JSON schema to make it available in documentation

Diff for: buf.doc.gen.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: v2
2+
plugins:
3+
# Local plugin used to generate docs
4+
# go install github.com/pseudomuto/protoc-gen-doc/cmd/[email protected]
5+
- local: protoc-gen-doc
6+
out: ./docs/rpc
7+
opt:
8+
- markdown,commands.md
9+
inputs:
10+
- directory: ./rpc

0 commit comments

Comments
 (0)