Skip to content

Commit

Permalink
Merge pull request #249 from meteorcloudy:stardoc-dev
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 683088422
Change-Id: Id6308c12494f4b591fd1d47ffbe84cb3b01b745d
  • Loading branch information
copybara-github committed Oct 7, 2024
2 parents 7343c66 + 083ace4 commit 37dacbb
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 39 deletions.
2 changes: 1 addition & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ module(

bazel_dep(name = "bazel_skylib", version = "1.7.1")
bazel_dep(name = "platforms", version = "0.0.10")
bazel_dep(name = "stardoc", version = "0.7.0")

cc_configure = use_extension("//cc:extensions.bzl", "cc_configure_extension")
use_repo(cc_configure, "local_config_cc", "local_config_cc_toolchains")

register_toolchains("@local_config_cc_toolchains//:all")

bazel_dep(name = "rules_testing", version = "0.6.0", dev_dependency = True)
bazel_dep(name = "stardoc", version = "0.7.0", dev_dependency = True)
37 changes: 0 additions & 37 deletions cc/toolchains/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@
# limitations under the License.

load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
load("@bazel_skylib//rules:expand_template.bzl", "expand_template")
load("@stardoc//stardoc:stardoc.bzl", "stardoc")
load("//cc/toolchains/impl:documented_api.bzl", "DOCUMENTED_TOOLCHAIN_RULES")
load("//cc/toolchains/impl:markdown_helpers.bzl", "xref_substitutions")

bzl_library(
name = "toolchain_rules",
Expand All @@ -42,35 +37,3 @@ filegroup(
]),
visibility = ["//visibility:public"],
)

stardoc(
name = "toolchain_api",
out = "raw_generated_toolchain_api.md",
input = "//cc/toolchains/impl:documented_api.bzl",
deps = [":toolchain_rules"],
)

expand_template(
name = "toolchain_api_md",
out = "generated_toolchain_api.md",
# Dictionary order 100% matters here!
# buildifier: disable=unsorted-dict-items
substitutions = {
# Strip @rules_cc to prevent instances of @rules_cc@rules_cc//cc.
"@rules_cc//cc": "//cc",
# In GitHub, we prefer to clarify all the labels that come from
# rules_cc.
"//cc": "@rules_cc//cc",
} | xref_substitutions({
"`{}`".format(rule_name): "#{}".format(rule_name)
for rule_name in DOCUMENTED_TOOLCHAIN_RULES
}),
# buildifier: enable=unsorted-dict-items
template = ":raw_generated_toolchain_api.md",
)

diff_test(
name = "toolchain_api_diff_test",
file1 = ":generated_toolchain_api.md",
file2 = ":toolchain_api.md",
)
2 changes: 1 addition & 1 deletion cc/toolchains/impl/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ load("@bazel_skylib//:bzl_library.bzl", "bzl_library")

exports_files(
["documented_api.bzl"],
visibility = ["//cc/toolchains:__subpackages__"],
visibility = ["//docs:__pkg__"],
)

bzl_library(
Expand Down
60 changes: 60 additions & 0 deletions docs/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Copyright 2024 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
load("@bazel_skylib//rules:expand_template.bzl", "expand_template")
load("@stardoc//stardoc:stardoc.bzl", "stardoc")
load("//cc/toolchains/impl:documented_api.bzl", "DOCUMENTED_TOOLCHAIN_RULES")
load("//cc/toolchains/impl:markdown_helpers.bzl", "xref_substitutions")

filegroup(
name = "srcs",
srcs = glob([
"**/*.bzl",
"**/BUILD",
]),
visibility = ["//visibility:public"],
)

stardoc(
name = "toolchain_api",
out = "raw_generated_toolchain_api.md",
input = "//cc/toolchains/impl:documented_api.bzl",
deps = ["//cc/toolchains:toolchain_rules"],
)

expand_template(
name = "toolchain_api_md",
out = "generated_toolchain_api.md",
# Dictionary order 100% matters here!
# buildifier: disable=unsorted-dict-items
substitutions = {
# Strip @rules_cc to prevent instances of @rules_cc@rules_cc//cc.
"@rules_cc//cc": "//cc",
# In GitHub, we prefer to clarify all the labels that come from
# rules_cc.
"//cc": "@rules_cc//cc",
} | xref_substitutions({
"`{}`".format(rule_name): "#{}".format(rule_name)
for rule_name in DOCUMENTED_TOOLCHAIN_RULES
}),
# buildifier: enable=unsorted-dict-items
template = ":raw_generated_toolchain_api.md",
)

diff_test(
name = "toolchain_api_diff_test",
file1 = ":generated_toolchain_api.md",
file2 = ":toolchain_api.md",
)
File renamed without changes.

0 comments on commit 37dacbb

Please sign in to comment.