Skip to content

Commit

Permalink
sui-rpc-api: generate docs with protoc-gen-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
bmwill committed Jan 9, 2025
1 parent 06c989c commit 202d638
Show file tree
Hide file tree
Showing 2 changed files with 2,934 additions and 0 deletions.
21 changes: 21 additions & 0 deletions crates/sui-rpc-api/generate-grpc-docs.sh
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/
Loading

0 comments on commit 202d638

Please sign in to comment.