Skip to content

Commit d5b47bf

Browse files
authored
Merge pull request #5565 from mboersma/fix-crd-docs-generation
Use crddoc tool to generate CRD documentation
2 parents 5ec5ca9 + 251e114 commit d5b47bf

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/book/install-and-build.sh

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ cd "${KUBE_ROOT}" || exit 1
2424
os=$(go env GOOS)
2525
arch=$(go env GOARCH)
2626
mdBookVersion="v0.4.40"
27-
genCRDAPIReferenceDocsVersion="642c3aa7441d324f54f5a9a6a1841ffffacf5aeb"
27+
genCRDAPIReferenceDocsVersion="ee012b7016522a56d9cef3ea9baed3e0cfc8ff0e"
2828

2929
# translate arch to rust's conventions (if we can)
3030
if [[ ${arch} == "amd64" ]]; then
@@ -64,19 +64,19 @@ ${cmd} /tmp/mdbook.${ext}
6464
chmod +x /tmp/mdbook
6565

6666
# Generate API docs
67-
genCRDAPIReferenceDocsPath="/tmp/gen-crd-api-reference-docs-${genCRDAPIReferenceDocsVersion}"
68-
genCRDAPIReferenceDocs="${genCRDAPIReferenceDocsPath}/gen-crd-api-reference-docs"
67+
genCRDAPIReferenceDocsPath="/tmp/crddoc-${genCRDAPIReferenceDocsVersion}"
68+
genCRDAPIReferenceDocs="${genCRDAPIReferenceDocsPath}/crddoc document crds"
6969
(
7070
cd /tmp
71-
curl --retry 3 -sL -o gen-crd-api-reference-docs.zip "https://github.com/ahmetb/gen-crd-api-reference-docs/archive/${genCRDAPIReferenceDocsVersion}.zip"
72-
unzip gen-crd-api-reference-docs.zip
73-
cd "gen-crd-api-reference-docs-${genCRDAPIReferenceDocsVersion}"
71+
curl --retry 3 -sL -o crddoc.zip "https://github.com/theunrepentantgeek/crddoc/archive/${genCRDAPIReferenceDocsVersion}.zip"
72+
unzip crddoc.zip
73+
cd "crddoc-${genCRDAPIReferenceDocsVersion}"
7474
go build .
7575
)
7676

77-
${genCRDAPIReferenceDocs} -config "${genCRDAPIReferenceDocsPath}/example-config.json" -template-dir "${genCRDAPIReferenceDocsPath}/template" -api-dir ./api/v1beta1 -out-file ./docs/book/src/reference/v1beta1-api-raw.html
78-
${genCRDAPIReferenceDocs} -config "${genCRDAPIReferenceDocsPath}/example-config.json" -template-dir "${genCRDAPIReferenceDocsPath}/template" -api-dir ./exp/api/v1beta1 -out-file ./docs/book/src/reference/v1beta1-exp-api-raw.html
79-
${genCRDAPIReferenceDocs} -config "${genCRDAPIReferenceDocsPath}/example-config.json" -template-dir "${genCRDAPIReferenceDocsPath}/template" -api-dir ./api/v1alpha1 -out-file ./docs/book/src/reference/v1alpha1-api-raw.html
77+
${genCRDAPIReferenceDocs} --config "${genCRDAPIReferenceDocsPath}/docs/config/crddoc-config.yaml" --template "${genCRDAPIReferenceDocsPath}/templates" --output ./docs/book/src/reference/v1beta1-api-raw.html ./api/v1beta1
78+
${genCRDAPIReferenceDocs} --config "${genCRDAPIReferenceDocsPath}/docs/config/crddoc-config.yaml" --template "${genCRDAPIReferenceDocsPath}/templates" --output ./docs/book/src/reference/v1beta1-exp-api-raw.html ./exp/api/v1beta1
79+
${genCRDAPIReferenceDocs} --config "${genCRDAPIReferenceDocsPath}/docs/config/crddoc-config.yaml" --template "${genCRDAPIReferenceDocsPath}/templates" --output ./docs/book/src/reference/v1alpha1-api-raw.html ./api/v1alpha1
8080

8181
# Finally build the book.
8282
(cd docs/book && /tmp/mdbook build)

0 commit comments

Comments
 (0)