Skip to content

Commit

Permalink
docs: generate proto docs into same dir (#105)
Browse files Browse the repository at this point in the history
Signed-off-by: Artur Troian <[email protected]>
  • Loading branch information
troian authored Jan 8, 2024
1 parent 683f978 commit 6693f6b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ have all been moved [under](./proto/node/akash). All generated code can be found
- `buf.build/akash-network/provider` - Akash manifest definitions previously defined as plan Go structs have been converted into Protobuf [definitions](./proto/provider/akash)

Proto docs are available:
- for [node](docs/proto/node/proto-docs.md)
- for [provider](docs/proto/provider/proto-docs.md)
- for [node](docs/proto/node.md)
- for [provider](docs/proto/provider.md)

## Contributing

Expand Down
8 changes: 4 additions & 4 deletions script/protocgen-legacy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ done
-I "proto/node" \
-I "vendor/github.com/cosmos/cosmos-sdk/proto" \
-I "vendor/github.com/cosmos/cosmos-sdk/third_party/proto" \
--doc_out=./docs/proto/node \
--doc_opt=./docs/protodoc-markdown.tmpl,proto-docs.md \
--doc_out=./docs/proto \
--doc_opt=./docs/protodoc-markdown.tmpl,node.md \
$(find "./proto/node" -maxdepth 4 -name '*.proto')

proto_dirs=$(find ./proto/provider -path -prune -o -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq)
Expand All @@ -61,8 +61,8 @@ done
-I "vendor/github.com/cosmos/cosmos-sdk/proto" \
-I "vendor/github.com/cosmos/cosmos-sdk/third_party/proto" \
-I "vendor" \
--doc_out=./docs/proto/provider \
--doc_opt=./docs/protodoc-markdown.tmpl,proto-docs.md \
--doc_out=./docs/proto \
--doc_opt=./docs/protodoc-markdown.tmpl,provider.md \
$(find "./proto/provider" -maxdepth 4 -name '*.proto')

# move proto files to the right places
Expand Down

0 comments on commit 6693f6b

Please sign in to comment.