19
19
20
20
# derive the package name from the name of the settings file (w/o the suffix):
21
21
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"
23
23
24
24
# settings from a sourced file (PRIORITY!) or the environment:
25
25
echo " Reading settings from file [$SETTINGS_FILE ]..."
@@ -144,7 +144,7 @@ export VERSIONS
144
144
export PACKAGENAME
145
145
146
146
run_pdoc () {
147
- echo -e " \n*** Generating docs for version [$CUR_VERSION ]..."
147
+ echo -e " \n⭐⭐⭐ Generating docs for version [$CUR_VERSION ]..."
148
148
# git reset -- .
149
149
git checkout -- .
150
150
@@ -174,6 +174,7 @@ run_pdoc() {
174
174
OUTPUT=" $DOCS_BASEDIR /$PACKAGENAME /$CUR_VERSION "
175
175
# echo "Output directory: [$OUTPUT]"
176
176
mkdir -p " $OUTPUT "
177
+ echo " 🏗 Running pdoc ⏳ ..."
177
178
$PDOC \
178
179
--template-directory " $PDOC_TEMPLATES " \
179
180
--output-directory " $OUTPUT " \
@@ -183,18 +184,20 @@ run_pdoc() {
183
184
--favicon " $FAVICON " \
184
185
" ${PKG_SRC} " /* |
185
186
sed " $PDOC_STDOUT_FILTER "
187
+ echo " 🎇 Pdoc finished."
186
188
}
187
189
188
190
for CUR_VERSION in $VERSIONS ; do
189
191
run_pdoc
190
192
done
191
193
192
- # create an index.html pointing to the latest release
194
+ echo " 🔄 Creating redirects to the latest release: "
193
195
INDEX_REDIRECT=" $DOCS_BASEDIR /$PACKAGENAME /index.html"
194
196
echo " <meta
195
197
http-equiv=\" Refresh\"
196
198
content=\" 0;
197
199
url='./${LATEST_STABLE} /index.html'\"
198
200
/>" > " $INDEX_REDIRECT "
201
+ echo " - $INDEX_REDIRECT "
199
202
200
- echo -e " \nDone. Output can be found at [ $INDEX_REDIRECT ] .\n"
203
+ echo -e " ✅ Done .\n"
0 commit comments