Skip to content

Commit 70d9a25

Browse files
authored
docs: remove buf comments (CycloneDX#880)
in the protobuf schema we use annotations for some linters and other tools. these annotations start with `buf:` these annotations are not meant for humans, so we dont need to render them in the docs. this PR removes these things from the docs.
2 parents b92bd46 + 8c484e9 commit 70d9a25

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docgen/proto/gen.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ generate () {
6767
sed -i -e "s/\${title}/$title/g" "$OUT_DIR/$OUT_FILE"
6868
sed -i -e "s/\${version}/$version/g" "$OUT_DIR/$OUT_FILE"
6969

70+
sed -i -E -e "s#(<p>)buf:.+</p>##g" "$OUT_DIR/$OUT_FILE"
71+
sed -i -E -e "s#^buf:[^<\n]+##g" "$OUT_DIR/$OUT_FILE"
72+
7073
inject_header "$OUT_DIR/$OUT_FILE" "$version" "proto"
7174
}
7275

0 commit comments

Comments
 (0)