Skip to content
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.

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

Generate api.md from sources #618

Merged
merged 1 commit into from
May 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
name = "io_bazel_stardoc",
patches = [],
patches = ["//doc:stardoc.pr103.patch"],
sha256 = "f89bda7b6b696c777b5cf0ba66c80d5aa97a6701977d43789a9aee319eef71e8",
strip_prefix = "stardoc-d93ee5347e2d9c225ad315094507e018364d5a67",
urls = [
Expand Down
16 changes: 16 additions & 0 deletions doc/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
load("@io_bazel_stardoc//stardoc:stardoc.bzl", "stardoc")

_DOC_SRCS = {
"api": [
"swift_common",
],
"aspects": [
"swift_usage_aspect",
],
Expand All @@ -24,6 +27,19 @@ _DOC_SRCS = {
],
}

write_file(
name = "api_header",
out = "api_header.vm",
content = [
"<!-- Generated with Stardoc, Do Not Edit! -->",
"# Build API",
"",
"The `swift_common` module provides API access to the behavior implemented",
"by the Swift build rules, so that other custom rules can invoke Swift",
"compilation and/or linking as part of their implementation.",
],
)

write_file(
name = "aspects_header",
out = "aspects_header.vm",
Expand Down
Loading