Documentation¶
Rules for generating protobuf Markdown, JSON, HTML or DocBook documentation with protoc-gen-doc
Rule |
Description |
---|---|
Generates DocBook |
|
Generates |
|
Generates |
|
Generates Markdown |
doc_docbook_compile¶
Note: This rule is experimental. It may not work correctly!
Generates DocBook .xml
documentation file
Example¶
Full example project can be found here
WORKSPACE
¶
load("@rules_proto_grpc//doc:repositories.bzl", rules_proto_grpc_doc_repos = "doc_repos")
rules_proto_grpc_doc_repos()
BUILD.bazel
¶
load("@rules_proto_grpc//doc:defs.bzl", "doc_docbook_compile")
doc_docbook_compile(
name = "person_doc_proto",
protos = ["@rules_proto_grpc//example/proto:person_proto"],
)
doc_docbook_compile(
name = "place_doc_proto",
protos = ["@rules_proto_grpc//example/proto:place_proto"],
)
doc_docbook_compile(
name = "thing_doc_proto",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
Attributes¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
Plugins¶
@rules_proto_grpc//doc:docbook_plugin
doc_html_compile¶
Note: This rule is experimental. It may not work correctly!
Generates .html
documentation file
Example¶
Full example project can be found here
WORKSPACE
¶
load("@rules_proto_grpc//doc:repositories.bzl", rules_proto_grpc_doc_repos = "doc_repos")
rules_proto_grpc_doc_repos()
BUILD.bazel
¶
load("@rules_proto_grpc//doc:defs.bzl", "doc_html_compile")
doc_html_compile(
name = "person_doc_proto",
protos = ["@rules_proto_grpc//example/proto:person_proto"],
)
doc_html_compile(
name = "place_doc_proto",
protos = ["@rules_proto_grpc//example/proto:place_proto"],
)
doc_html_compile(
name = "thing_doc_proto",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
Attributes¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
Plugins¶
@rules_proto_grpc//doc:html_plugin
doc_json_compile¶
Note: This rule is experimental. It may not work correctly!
Generates .json
documentation file
Example¶
Full example project can be found here
WORKSPACE
¶
load("@rules_proto_grpc//doc:repositories.bzl", rules_proto_grpc_doc_repos = "doc_repos")
rules_proto_grpc_doc_repos()
BUILD.bazel
¶
load("@rules_proto_grpc//doc:defs.bzl", "doc_json_compile")
doc_json_compile(
name = "person_doc_proto",
protos = ["@rules_proto_grpc//example/proto:person_proto"],
)
doc_json_compile(
name = "place_doc_proto",
protos = ["@rules_proto_grpc//example/proto:place_proto"],
)
doc_json_compile(
name = "thing_doc_proto",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
Attributes¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
Plugins¶
@rules_proto_grpc//doc:json_plugin
doc_markdown_compile¶
Note: This rule is experimental. It may not work correctly!
Generates Markdown .md
documentation file
Example¶
Full example project can be found here
WORKSPACE
¶
load("@rules_proto_grpc//doc:repositories.bzl", rules_proto_grpc_doc_repos = "doc_repos")
rules_proto_grpc_doc_repos()
BUILD.bazel
¶
load("@rules_proto_grpc//doc:defs.bzl", "doc_markdown_compile")
doc_markdown_compile(
name = "person_doc_proto",
protos = ["@rules_proto_grpc//example/proto:person_proto"],
)
doc_markdown_compile(
name = "place_doc_proto",
protos = ["@rules_proto_grpc//example/proto:place_proto"],
)
doc_markdown_compile(
name = "thing_doc_proto",
protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)
Attributes¶
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra args to pass directly to protoc, not as plugin options |
Plugins¶
@rules_proto_grpc//doc:markdown_plugin