docs/BUILD

# 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("@rules_shell//shell:sh_binary.bzl", "sh_binary")
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",
        ],
        allow_empty = True,
    ),
    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",
    ],
)

stardoc(
    name = "cc_binary",
    out = "cc_binary.md",
    input = "//cc:cc_binary.bzl",
    deps = ["//cc:core_rules"],
)

stardoc(
    name = "cc_library",
    out = "cc_library.md",
    input = "//cc:cc_library.bzl",
    deps = ["//cc:core_rules"],
)

stardoc(
    name = "cc_import",
    out = "cc_import.md",
    input = "//cc:cc_import.bzl",
    deps = ["//cc:core_rules"],
)

stardoc(
    name = "cc_shared_library",
    out = "cc_shared_library.md",
    input = "//cc:cc_shared_library.bzl",
    deps = ["//cc:core_rules"],
)

stardoc(
    name = "cc_static_library",
    out = "cc_static_library.md",
    input = "//cc:cc_static_library.bzl",
    deps = ["//cc:core_rules"],
)

stardoc(
    name = "cc_test",
    out = "cc_test.md",
    input = "//cc:cc_test.bzl",
    deps = ["//cc:core_rules"],
)

stardoc(
    name = "cc_common",
    out = "cc_common.md",
    input = "//cc/common:cc_common.bzl",
    deps = ["//cc/common"],
)

stardoc(
    name = "cc_info",
    out = "cc_info.md",
    input = "//cc/common:cc_info.bzl",
    deps = ["//cc/common"],
)

stardoc(
    name = "objc_import",
    out = "objc_import.md",
    input = "//cc:objc_import.bzl",
    deps = ["//cc:core_rules"],
)

stardoc(
    name = "objc_library",
    out = "objc_library.md",
    input = "//cc:objc_library.bzl",
    deps = ["//cc:core_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",
)

_UPDATE_FILES = {
    ":toolchain_api_md": "docs/toolchain_api.md",
}

sh_binary(
    name = "update",
    srcs = ["update.sh"],
    args = [
        arg
        for src, dst in _UPDATE_FILES.items()
        for arg in (
            "$(rootpath {})".format(src),
            dst,
        )
    ],
    data = _UPDATE_FILES.keys(),
)