Skip to content

Commit

Permalink
modify scripts to generate API docs
Browse files Browse the repository at this point in the history
Signed-off-by: Meg McRoberts <[email protected]>
  • Loading branch information
StackScribe committed Mar 30, 2023
1 parent f60b150 commit a993edb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions .github/scripts/generate-crd-docs/generate-crd-docs.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

# CRD docs auto generation script
# API docs auto generation script
#
# This script goes through all API definitions in the operator/apis folder
# and generates docs from code for each API group and version
Expand All @@ -23,7 +23,7 @@ else
echo "Docs generator is installed, continuing..."
fi

echo "Running CRD docs auto-generator..."
echo "Running API docs auto-generator..."

for api_group in "$API_ROOT"*; do
sanitized_api_group="${api_group#$API_ROOT}"
Expand Down Expand Up @@ -55,7 +55,7 @@ for api_group in "$API_ROOT"*; do
echo "Creating docs folder $OUTPUT_PATH..."
mkdir -p "$OUTPUT_PATH"

echo "Generating CRD docs for $sanitized_api_group.$API_DOMAIN/$sanitized_api_version..."
echo "Generating API docs for $sanitized_api_group.$API_DOMAIN/$sanitized_api_version..."
api-ref-docs \
--templates-dir "$TEMPLATE_DIR" \
--source-path="./$api_version" \
Expand Down

0 comments on commit a993edb

Please sign in to comment.