Skip to content

Generate providers.md from sources #599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keith merged 2 commits into from
Apr 30, 2021
Merged

Generate providers.md from sources #599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5aab0a3
Update rules.md to match generated
alexeagle Apr 30, 2021
1e1aeb0
docs: providers.md now generated from sources
alexeagle Apr 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 50 additions & 8 deletions doc/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,16 @@ _RULES_SYMBOLS = [
"swift_test",
]

_PROVIDERS_SYMBOLS = [
"SwiftInfo",
"SwiftToolchainInfo",
"SwiftProtoInfo",
"SwiftUsageInfo",
]

write_file(
name = "gen_header",
out = "header.vm",
name = "rules_header",
out = "rules_header.vm",
content = [
"<!-- Generated with Stardoc, Do Not Edit! -->",
"",
Expand All @@ -27,19 +34,54 @@ write_file(
],
)

write_file(
name = "providers_header",
out = "providers_header.vm",
content = [
"<!-- Generated with Stardoc, Do Not Edit! -->",
"",
"The providers described below are propagated and required by various Swift",
"build rules. Clients interested in writing custom rules that interface",
"with the rules in this package should use these providers to communicate",
"with the Swift build rules as needed.",
"",
"On this page:",
"",
] + [" * [{0}](#{0})".format(r) for r in _PROVIDERS_SYMBOLS] + [
"",
],
)

stardoc(
name = "doc",
out = "swift.md",
header_template = ":header.vm",
name = "rules_doc",
out = "rules.md_",
header_template = ":rules_header.vm",
input = "//swift:swift.bzl",
symbol_names = _RULES_SYMBOLS,
deps = ["//swift"],
)

stardoc(
name = "providers_doc",
out = "providers.md_",
header_template = ":providers_header.vm",
input = "//swift:swift.bzl",
symbol_names = _PROVIDERS_SYMBOLS,
deps = ["//swift"],
)

# To make this test pass, run
# bazel build doc:all && cp bazel-bin/doc/swift.md doc/rules.md
# bazel build doc:all && cp bazel-bin/doc/rules.md_ doc/rules.md
diff_test(
name = "test",
file1 = "swift.md",
name = "test_rules",
file1 = "rules.md_",
file2 = "rules.md",
)

# To make this test pass, run
# bazel build doc:all && cp bazel-bin/doc/providers.md_ doc/providers.md
diff_test(
name = "test_providers",
file1 = "providers.md_",
file2 = "providers.md",
)
Loading