Add rules for protoc-gen-doc, closes rules-proto-grpc#2

titanous · Feb 23, 2021 · c34e8b9 · c34e8b9
1 parent e37d6f0
commit c34e8b9
Show file tree

Hide file tree

Showing 28 changed files with 1,026 additions and 2 deletions.
diff --git a/.bazelci/presubmit.yml b/.bazelci/presubmit.yml
@@ -13,6 +13,7 @@ tasks:
     - "//cpp/..."
     - "//csharp/..."
     - "//d/..."
+    - "//doc/..."
     - "//go/..."
     - "//grpc-gateway/..."
     - "//java/..."
@@ -97,6 +98,7 @@ tasks:
     - "//cpp/..."
     - "//csharp/..."
     - "//d/..."
+    - "//doc/..."
     - "//go/..."
     - "//grpc-gateway/..."
     - "//java/..."
@@ -500,6 +502,94 @@ tasks:
     build_targets:
       - "//..."
     working_directory: example/d/d_proto_library
+  doc_doc_docbook_compile_ubuntu1804:
+    name: 'doc: doc_docbook_compile'
+    platform: ubuntu1804
+    build_flags:
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_docbook_compile
+  doc_doc_docbook_compile_windows:
+    name: 'doc: doc_docbook_compile'
+    platform: windows
+    build_flags:
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_docbook_compile
+  doc_doc_docbook_compile_macos:
+    name: 'doc: doc_docbook_compile'
+    platform: macos
+    build_flags:
+    - "--copt=-DGRPC_BAZEL_BUILD"
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_docbook_compile
+  doc_doc_html_compile_ubuntu1804:
+    name: 'doc: doc_html_compile'
+    platform: ubuntu1804
+    build_flags:
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_html_compile
+  doc_doc_html_compile_windows:
+    name: 'doc: doc_html_compile'
+    platform: windows
+    build_flags:
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_html_compile
+  doc_doc_html_compile_macos:
+    name: 'doc: doc_html_compile'
+    platform: macos
+    build_flags:
+    - "--copt=-DGRPC_BAZEL_BUILD"
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_html_compile
+  doc_doc_json_compile_ubuntu1804:
+    name: 'doc: doc_json_compile'
+    platform: ubuntu1804
+    build_flags:
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_json_compile
+  doc_doc_json_compile_windows:
+    name: 'doc: doc_json_compile'
+    platform: windows
+    build_flags:
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_json_compile
+  doc_doc_json_compile_macos:
+    name: 'doc: doc_json_compile'
+    platform: macos
+    build_flags:
+    - "--copt=-DGRPC_BAZEL_BUILD"
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_json_compile
+  doc_doc_markdown_compile_ubuntu1804:
+    name: 'doc: doc_markdown_compile'
+    platform: ubuntu1804
+    build_flags:
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_markdown_compile
+  doc_doc_markdown_compile_windows:
+    name: 'doc: doc_markdown_compile'
+    platform: windows
+    build_flags:
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_markdown_compile
+  doc_doc_markdown_compile_macos:
+    name: 'doc: doc_markdown_compile'
+    platform: macos
+    build_flags:
+    - "--copt=-DGRPC_BAZEL_BUILD"
+    build_targets:
+      - "//..."
+    working_directory: example/doc/doc_markdown_compile
   go_go_proto_compile_ubuntu1804:
     name: 'go: go_proto_compile'
     platform: ubuntu1804

diff --git a/README.md b/README.md
@@ -39,6 +39,7 @@ Bazel 4.0 compatibility and updated dependencies are in progress.
     - [C++](/cpp/README.md)
     - [C#](/csharp/README.md)
     - [D](/d/README.md)
+    - [Documentation](/doc/README.md)
     - [Go](/go/README.md)
     - [grpc-gateway](/grpc-gateway/README.md)
     - [Java](/java/README.md)
@@ -137,6 +138,10 @@ repository.
 | [C#](/csharp) | [csharp_grpc_library](/csharp#csharp_grpc_library) | Generates a C# protobuf+gRPC library using `csharp_library` from `rules_dotnet`. Note that the library name must end in `.dll` ([example](/example/csharp/csharp_grpc_library)) |
 | [D](/d) | [d_proto_compile](/d#d_proto_compile) | Generates D protobuf `.d` artifacts ([example](/example/d/d_proto_compile)) |
 | [D](/d) | [d_proto_library](/d#d_proto_library) | Generates a D protobuf library using `d_library` from `rules_d` ([example](/example/d/d_proto_library)) |
+| [Documentation](/doc) | [doc_docbook_compile](/doc#doc_docbook_compile) | Generates DocBook `.xml` documentation artifact ([example](/example/doc/doc_docbook_compile)) |
+| [Documentation](/doc) | [doc_html_compile](/doc#doc_html_compile) | Generates `.html` documentation artifact ([example](/example/doc/doc_html_compile)) |
+| [Documentation](/doc) | [doc_json_compile](/doc#doc_json_compile) | Generates `.json` documentation artifact ([example](/example/doc/doc_json_compile)) |
+| [Documentation](/doc) | [doc_markdown_compile](/doc#doc_markdown_compile) | Generates `.md` documentation artifact ([example](/example/doc/doc_markdown_compile)) |
 | [Go](/go) | [go_proto_compile](/go#go_proto_compile) | Generates Go protobuf `.go` artifacts ([example](/example/go/go_proto_compile)) |
 | [Go](/go) | [go_grpc_compile](/go#go_grpc_compile) | Generates Go protobuf+gRPC `.go` artifacts ([example](/example/go/go_grpc_compile)) |
 | [Go](/go) | [go_proto_library](/go#go_proto_library) | Generates a Go protobuf library using `go_library` from `rules_go` ([example](/example/go/go_proto_library)) |

diff --git a/doc/BUILD.bazel b/doc/BUILD.bazel
@@ -0,0 +1,65 @@
+load("//:defs.bzl", "proto_plugin")
+
+proto_plugin(
+    name = "docbook_plugin",
+    options = [
+        "docbook",
+        "{name}.xml",
+    ],
+    out = "{name}.xml",
+    tool = select({
+        "@bazel_tools//src/conditions:darwin_x86_64": "@protoc_gen_doc_darwin//:protoc-gen-doc",
+        "@bazel_tools//src/conditions:linux_x86_64": "@protoc_gen_doc_linux//:protoc-gen-doc",
+        "@bazel_tools//src/conditions:windows": "@protoc_gen_doc_windows//:protoc-gen-doc",
+    }),
+    visibility = ["//visibility:public"],
+    quirks = ["QUIRK_OUT_PASS_ROOT"],
+)
+
+proto_plugin(
+    name = "html_plugin",
+    options = [
+        "html",
+        "{name}.html",
+    ],
+    out = "{name}.html",
+    tool = select({
+        "@bazel_tools//src/conditions:darwin_x86_64": "@protoc_gen_doc_darwin//:protoc-gen-doc",
+        "@bazel_tools//src/conditions:linux_x86_64": "@protoc_gen_doc_linux//:protoc-gen-doc",
+        "@bazel_tools//src/conditions:windows": "@protoc_gen_doc_windows//:protoc-gen-doc",
+    }),
+    visibility = ["//visibility:public"],
+    quirks = ["QUIRK_OUT_PASS_ROOT"],
+)
+
+proto_plugin(
+    name = "json_plugin",
+    options = [
+        "json",
+        "{name}.json",
+    ],
+    out = "{name}.json",
+    tool = select({
+        "@bazel_tools//src/conditions:darwin_x86_64": "@protoc_gen_doc_darwin//:protoc-gen-doc",
+        "@bazel_tools//src/conditions:linux_x86_64": "@protoc_gen_doc_linux//:protoc-gen-doc",
+        "@bazel_tools//src/conditions:windows": "@protoc_gen_doc_windows//:protoc-gen-doc",
+    }),
+    visibility = ["//visibility:public"],
+    quirks = ["QUIRK_OUT_PASS_ROOT"],
+)
+
+proto_plugin(
+    name = "markdown_plugin",
+    options = [
+        "markdown",
+        "{name}.md",
+    ],
+    out = "{name}.md",
+    tool = select({
+        "@bazel_tools//src/conditions:darwin_x86_64": "@protoc_gen_doc_darwin//:protoc-gen-doc",
+        "@bazel_tools//src/conditions:linux_x86_64": "@protoc_gen_doc_linux//:protoc-gen-doc",
+        "@bazel_tools//src/conditions:windows": "@protoc_gen_doc_windows//:protoc-gen-doc",
+    }),
+    visibility = ["//visibility:public"],
+    quirks = ["QUIRK_OUT_PASS_ROOT"],
+)