-
Notifications
You must be signed in to change notification settings - Fork 11.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
sui-rpc-api: generate docs with protoc-gen-doc
- Loading branch information
Showing
2 changed files
with
2,934 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
#!/bin/bash | ||
# Copyright (c) Mysten Labs, Inc. | ||
# SPDX-License-Identifier: Apache-2.0 | ||
|
||
set -x | ||
set -e | ||
|
||
SCRIPT_PATH=$(realpath "$0") | ||
SCRIPT_DIR=$(dirname "$SCRIPT_PATH") | ||
|
||
PROTO_FILES=( | ||
proto/sui.node.v2.proto | ||
proto/sui.types.proto | ||
proto/google/protobuf/empty.proto | ||
proto/google/protobuf/timestamp.proto | ||
) | ||
|
||
# requires that protoc as well as the protoc-gen-doc plugin is installed and | ||
# available on $PATH. See https://github.com/pseudomuto/protoc-gen-doc for more | ||
# info | ||
cd "$SCRIPT_DIR" && protoc --doc_out=proto/ --doc_opt=markdown,documentation.md ${PROTO_FILES[@]} --proto_path=proto/ |
Oops, something went wrong.