diff --git a/NOTICE.txt b/NOTICE.txt index c97a8ab5e..0c3ee5192 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -8,6 +8,10 @@ in whole or part of, in any medium, except as required for reasonable and custom and reproducing the content of the NOTICE and DOCUMENTATION files. Any use or displaying shall constitute an infringement under intellectual property laws of France and international conventions. +./docs_release/docs_assets/apple-touch-icon.png +./docs_release/docs_assets/favicon-16x16.png +./docs_release/docs_assets/favicon-32x32.png +./docs_release/docs_assets/favicon.ico ./Showcase/Showcase/Resources/Assets.xcassets/AppIconDev.appiconset/iPhone-App-60@2x.png ./Showcase/Showcase/Resources/Assets.xcassets/AppIconDev.appiconset/iPhone-App-60@3x.png diff --git a/docs_release/docs_assets/apple-touch-icon.png b/docs_release/docs_assets/apple-touch-icon.png new file mode 100644 index 000000000..e3115cf1e Binary files /dev/null and b/docs_release/docs_assets/apple-touch-icon.png differ diff --git a/docs_release/docs_assets/favicon-16x16.png b/docs_release/docs_assets/favicon-16x16.png new file mode 100644 index 000000000..a9c5d2fa9 Binary files /dev/null and b/docs_release/docs_assets/favicon-16x16.png differ diff --git a/docs_release/docs_assets/favicon-32x32.png b/docs_release/docs_assets/favicon-32x32.png new file mode 100644 index 000000000..1faba7e25 Binary files /dev/null and b/docs_release/docs_assets/favicon-32x32.png differ diff --git a/docs_release/docs_assets/favicon.ico b/docs_release/docs_assets/favicon.ico new file mode 100644 index 000000000..7f6945a4e Binary files /dev/null and b/docs_release/docs_assets/favicon.ico differ diff --git a/docs_release/uploadWebDoc.sh b/docs_release/uploadWebDoc.sh index 896bf3a7d..ff697e48b 100755 --- a/docs_release/uploadWebDoc.sh +++ b/docs_release/uploadWebDoc.sh @@ -47,6 +47,9 @@ HTML_PROJECT_WIKI_URL="https://github.com/Orange-OpenSource/ouds-ios/wiki" # We suppose all the documentation will be in this dedicated branch. SERVICE_PAGES_BRANCH="gh-pages" +# Path where assets to copy are +ASSETS_DIRECTORY="./docs_assets" + # Path where the documentation will be temporary DOCS_DIRECTORY="../docs" @@ -274,9 +277,16 @@ _ "👉 All index.json files processed, now time to merge them" python3 merge-json-indexes.py "$DOCS_DIRECTORY/index" _ "👍 Merge done!" -# Step 3 - Add CNAME file for GitHub Pages -# ---------------------------------------- +# Step 3 - Add custom assets +# -------------------------- + +# Some custom assets for the website +cp "$ASSETS_DIRECTORY/apple-touch-icon.png" "$DOCS_DIRECTORY/" +cp "$ASSETS_DIRECTORY/favicon-16x16.png" "$DOCS_DIRECTORY/" +cp "$ASSETS_DIRECTORY/favicon-32x32.png" "$DOCS_DIRECTORY/" +cp "$ASSETS_DIRECTORY/favicon.ico" "$DOCS_DIRECTORY/" +# CNAME for GitHub Pages etc. if [[ $use_git -eq 1 ]]; then _ "👉 Updating CNAME file" echo "$SERVICE_PAGES_DOMAIN" > "$DOCS_DIRECTORY/CNAME" @@ -290,7 +300,19 @@ fi _ "👉 Updating index.html..." -echo "$HTML_TITLE

$HTML_H1

" > $DOCS_DIRECTORY/index.html +echo "" > $DOCS_DIRECTORY/index.html +echo "" >> $DOCS_DIRECTORY/index.html +echo "" >> $DOCS_DIRECTORY/index.html +echo "$HTML_TITLE" >> $DOCS_DIRECTORY/index.html +echo "" >> $DOCS_DIRECTORY/index.html +echo "" >> $DOCS_DIRECTORY/index.html +echo "" >> $DOCS_DIRECTORY/index.html +echo "" >> $DOCS_DIRECTORY/index.html +echo "" >> $DOCS_DIRECTORY/index.html +echo "" >> $DOCS_DIRECTORY/index.html +echo "

$HTML_H1

" >> $DOCS_DIRECTORY/index.html +echo "
" >> $DOCS_DIRECTORY/index.html + echo "

$HTML_H2

" >> $DOCS_DIRECTORY/index.html echo "

Version v$lib_version

" >> $DOCS_DIRECTORY/index.html echo "

All targets of the Swift Package are listed below

" >> $DOCS_DIRECTORY/index.html @@ -353,8 +375,14 @@ if [[ $use_git -eq 1 ]]; then cp -r "$DOCUMENTATION_HTML_LOCATION/index/"* "$DOCS_DIRECTORY/index/" cp -r "$DOCUMENTATION_HTML_LOCATION/js/"* "$DOCS_DIRECTORY/js/" - cp -r "$DOCUMENTATION_HTML_LOCATION/CNAME" "$DOCS_DIRECTORY/" - cp -r "$DOCUMENTATION_HTML_LOCATION/index.html" "$DOCS_DIRECTORY/" + cp "$DOCUMENTATION_HTML_LOCATION/CNAME" "$DOCS_DIRECTORY/" + cp "$DOCUMENTATION_HTML_LOCATION/index.html" "$DOCS_DIRECTORY/" + + # Some custom assets for the website + cp "$DOCUMENTATION_HTML_LOCATION/apple-touch-icon.png" "$DOCS_DIRECTORY/" + cp "$DOCUMENTATION_HTML_LOCATION/favicon-16x16.png" "$DOCS_DIRECTORY/" + cp "$DOCUMENTATION_HTML_LOCATION/favicon-32x32.png" "$DOCS_DIRECTORY/" + cp "$DOCUMENTATION_HTML_LOCATION/favicon.ico" "$DOCS_DIRECTORY/" _ "🔨 Adding things (~ $files_count files)" git add "$DOCS_DIRECTORY"