Skip to content

Commit 97ef0df

Browse files
committed
Create docs/ folder and move container_image documentation there.
This documentation is now generated from sources rather than hand-maintained in markdown/HTML. Move the existing starlark target there, and check in the generated output. Uses generated_file_test since that prints the bazel run command to accept the new file, making this workflow easy for novice contributors to follow. Also don't make users install the stardoc repository anymore, now that they don't load() from this BUILD file they shouldn't need it.
1 parent f5f6ae6 commit 97ef0df

8 files changed

Lines changed: 697 additions & 612 deletions

File tree

README.md

Lines changed: 1 addition & 453 deletions
Large diffs are not rendered by default.

WORKSPACE

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,3 +516,14 @@ load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kotlin_repositories", "kt_reg
516516
kotlin_repositories()
517517

518518
kt_register_toolchains()
519+
520+
# For API doc generation
521+
http_archive(
522+
name = "io_bazel_stardoc",
523+
patches = [],
524+
sha256 = "f89bda7b6b696c777b5cf0ba66c80d5aa97a6701977d43789a9aee319eef71e8",
525+
strip_prefix = "stardoc-d93ee5347e2d9c225ad315094507e018364d5a67",
526+
urls = [
527+
"https://github.com/bazelbuild/stardoc/archive/d93ee5347e2d9c225ad315094507e018364d5a67.tar.gz",
528+
],
529+
)

container/BUILD

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
# limitations under the License.
1414

1515
load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
16-
load("@io_bazel_stardoc//stardoc:stardoc.bzl", "stardoc")
1716

1817
package(default_visibility = ["//visibility:public"])
1918

@@ -192,13 +191,6 @@ bzl_library(
192191
],
193192
)
194193

195-
stardoc(
196-
name = "image_doc",
197-
out = "image.md",
198-
input = ":image.bzl",
199-
deps = [":image"],
200-
)
201-
202194
bzl_library(
203195
name = "import",
204196
srcs = ["import.bzl"],

0 commit comments

Comments
 (0)