Skip to content

Commit 0c1506c

Browse files
committed
Emojis to improve readability of wrapper output
1 parent 721548a commit 0c1506c

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

scripts/multiversion-pdoc-wrapper

+7-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ fi
1919

2020
# derive the package name from the name of the settings file (w/o the suffix):
2121
PACKAGENAME=$(basename "${SETTINGS_FILE%.inc.sh}")
22-
echo -e "\n\n======= Building API docs for package [$PACKAGENAME] =======\n\n"
22+
echo -e "\n\n🎈 🎈 🎈 Building API docs for package [$PACKAGENAME] 🎈 🎈 🎈\n\n"
2323

2424
# settings from a sourced file (PRIORITY!) or the environment:
2525
echo "Reading settings from file [$SETTINGS_FILE]..."
@@ -144,7 +144,7 @@ export VERSIONS
144144
export PACKAGENAME
145145

146146
run_pdoc() {
147-
echo -e "\n*** Generating docs for version [$CUR_VERSION]..."
147+
echo -e "\n⭐⭐⭐ Generating docs for version [$CUR_VERSION]..."
148148
# git reset -- .
149149
git checkout -- .
150150

@@ -174,6 +174,7 @@ run_pdoc() {
174174
OUTPUT="$DOCS_BASEDIR/$PACKAGENAME/$CUR_VERSION"
175175
# echo "Output directory: [$OUTPUT]"
176176
mkdir -p "$OUTPUT"
177+
echo "🏗 Running pdoc ⏳ ..."
177178
$PDOC \
178179
--template-directory "$PDOC_TEMPLATES" \
179180
--output-directory "$OUTPUT" \
@@ -183,18 +184,20 @@ run_pdoc() {
183184
--favicon "$FAVICON" \
184185
"${PKG_SRC}"/* |
185186
sed "$PDOC_STDOUT_FILTER"
187+
echo "🎇 Pdoc finished."
186188
}
187189

188190
for CUR_VERSION in $VERSIONS; do
189191
run_pdoc
190192
done
191193

192-
# create an index.html pointing to the latest release
194+
echo "🔄 Creating redirects to the latest release:"
193195
INDEX_REDIRECT="$DOCS_BASEDIR/$PACKAGENAME/index.html"
194196
echo "<meta
195197
http-equiv=\"Refresh\"
196198
content=\"0;
197199
url='./${LATEST_STABLE}/index.html'\"
198200
/>" > "$INDEX_REDIRECT"
201+
echo "- $INDEX_REDIRECT"
199202

200-
echo -e "\nDone. Output can be found at [$INDEX_REDIRECT].\n"
203+
echo -e "✅ Done.\n"

0 commit comments

Comments
 (0)