1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
# Copyright 2021 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.
"""Generate the reference documentation.
How to:
bazel build //doc_build:reference
cp bazel-bin/doc_build/reference.md docs/latest.md
git commit -m 'update docs' docs/latest.md
"""
load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
load("@bazel_stardoc//stardoc:stardoc.bzl", "stardoc")
load("@rules_python//python:defs.bzl", "py_library")
load("//:version.bzl", "version")
package(default_applicable_licenses = ["//:license"])
filegroup(
name = "standard_package",
srcs = [
"BUILD",
] + glob([
"*.bzl",
"*.py",
]),
visibility = ["//distro:__pkg__"],
)
exports_files(
glob([
"*.bzl",
]),
visibility = [
"//distro:__pkg__",
"//doc_build:__pkg__",
],
)
# pairs of rule name and the source file to get it from
# buildifier: leave-alone, do not sort
ORDER = [
("toc", None),
("common", None),
("pkg_deb", "//pkg/private/deb:deb.bzl"),
("pkg_deb_impl", "//pkg/private/deb:deb.bzl"),
("pkg_rpm", "//pkg:rpm_pfg.bzl"),
("pkg_tar", "//pkg/private/tar:tar.bzl"),
("pkg_tar_impl", "//pkg/private/tar:tar.bzl"),
("pkg_zip", "//pkg/private/zip:zip.bzl"),
("pkg_zip_impl", "//pkg/private/zip:zip.bzl"),
("mappings", None),
("legacy_pkg_rpm", None),
]
genrule(
name = "reference",
srcs = ["%s.md" % rule for rule, _ in ORDER],
outs = ["reference.md"],
cmd = "$(location :merge) $(SRCS) >$@",
tools = [":merge"],
)
[
stardoc(
name = "%s_gen" % rule,
out = "%s.md" % rule,
input = src,
symbol_names = [
rule,
],
deps = [":rules_pkg_lib"],
)
for rule, src in ORDER
if src
]
genrule(
name = "toc",
srcs = ["toc.md.tpl"],
outs = ["toc.md"],
cmd = "sed -e 's/{VERSION}/%s/' $(SRCS) >$@" % version,
)
# Generate separately or there will be a conflict with the other pkg_rpm.
stardoc(
name = "docs_legacy_rpm",
out = "legacy_pkg_rpm.md",
input = "//pkg/legacy:rpm.bzl",
deps = [":rules_pkg_lib"],
)
# Mappings has a lot of pure rules, so it is mostly in a good order.
stardoc(
name = "mappings",
out = "mappings.md",
input = "//pkg:mappings.bzl",
deps = [
":rules_pkg_lib",
],
)
# gather all rules that should be documented
bzl_library(
name = "rules_pkg_lib",
srcs = [
"//:version.bzl",
"//pkg:bzl_srcs",
"@bazel_skylib//lib:paths",
],
visibility = ["//visibility:public"],
)
py_binary(
name = "merge",
srcs = ["merge.py"],
python_version = "PY3",
srcs_version = "PY3",
visibility = ["//visibility:private"],
)
|
