Skip to content

Commit 1f42698

Browse files
authored
docs: docsgen resture output for website (#570)
fixes #568 Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
1 parent 19c11ba commit 1f42698

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

docgen/json/gen.sh

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ DOCS_PATH="$THIS_PATH/docs"
77
TEMPLATES_PATH="$THIS_PATH/templates"
88

99
rm -f -R "$DOCS_PATH"
10-
mkdir -p "$DOCS_PATH/"{1.2,1.3,1.4,1.5,1.6}
1110

1211
# Check to see if generate-schema-doc is executable and is in the path. If not, install JSON Schema for Humans.
1312
if ! [ -x "$(command -v generate-schema-doc)" ]
@@ -27,7 +26,10 @@ generate () {
2726
then
2827
SCHEMA_FILE="$STRICT_SCHEMA_FILE"
2928
fi
30-
echo "$SCHEMA_FILE"
29+
echo "SCHEMA_FILE: $SCHEMA_FILE"
30+
31+
OUT_FILE="$DOCS_PATH/$version/json/index.html"
32+
mkdir -p "$(dirname "$OUT_FILE")"
3133

3234
generate-schema-doc \
3335
--config no_link_to_reused_ref \
@@ -38,11 +40,11 @@ generate () {
3840
--config custom_template_path="$TEMPLATES_PATH/cyclonedx/base.html" \
3941
--minify \
4042
"$SCHEMA_FILE" \
41-
"$DOCS_PATH/$version/index.html"
43+
"$OUT_FILE"
4244

43-
sed -i -e "s/\${quotedTitle}/\"$title\"/g" "$DOCS_PATH/$version/index.html"
44-
sed -i -e "s/\${title}/$title/g" "$DOCS_PATH/$version/index.html"
45-
sed -i -e "s/\${version}/$version/g" "$DOCS_PATH/$version/index.html"
45+
sed -i -e "s/\${quotedTitle}/\"$title\"/g" "$OUT_FILE"
46+
sed -i -e "s/\${title}/$title/g" "$OUT_FILE"
47+
sed -i -e "s/\${version}/$version/g" "$OUT_FILE"
4648
}
4749

4850
generate 1.2

docgen/xml/gen.sh

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ rm -rf "$DOCS_PATH"
1515

1616
SAXON_JAR="Saxon-HE-${SAXON_VERSION}.jar"
1717
if [ ! -f "$THIS_PATH/$SAXON_JAR" ]; then
18+
echo "fetching $SAXON_JAR"
1819
curl --output-dir "$THIS_PATH" -O \
1920
"https://repo1.maven.org/maven2/net/sf/saxon/Saxon-HE/$SAXON_VERSION/$SAXON_JAR"
2021
fi
@@ -25,11 +26,14 @@ generate () {
2526
title="CycloneDX v$version XML Reference"
2627
echo "Generating: $title"
2728

29+
OUT_FILE="$DOCS_PATH/$version/xml/index.html"
30+
mkdir -p "$(dirname "$OUT_FILE")"
31+
2832
## docs: https://www.saxonica.com/documentation10/index.html#!using-xsl/commandline
2933
java -jar "$THIS_PATH/$SAXON_JAR" \
3034
-s:"$SCHEMA_PATH/bom-${version}.xsd" \
3135
-xsl:"$THIS_PATH/xs3p.xsl" \
32-
-o:"$DOCS_PATH/$version/index.html" \
36+
-o:"$OUT_FILE" \
3337
cycloneDxVersion="$version" \
3438
title="$title"
3539
}

0 commit comments

Comments
 (0)