From da7af62cfa61acb8f477110d2fb6deb86a4871f5 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Lapersonne Date: Wed, 13 Nov 2024 11:34:05 +0100 Subject: [PATCH] ci(documentation): add favicons for landing page of online documentation Signed-off-by: Pierre-Yves Lapersonne --- NOTICE.txt | 4 +++ docs_release/docs_assets/apple-touch-icon.png | Bin 0 -> 3862 bytes docs_release/docs_assets/favicon-16x16.png | Bin 0 -> 118 bytes docs_release/docs_assets/favicon-32x32.png | Bin 0 -> 129 bytes docs_release/docs_assets/favicon.ico | Bin 0 -> 15086 bytes docs_release/uploadWebDoc.sh | 27 ++++++++++++++++-- 6 files changed, 28 insertions(+), 3 deletions(-) create mode 100644 docs_release/docs_assets/apple-touch-icon.png create mode 100644 docs_release/docs_assets/favicon-16x16.png create mode 100644 docs_release/docs_assets/favicon-32x32.png create mode 100644 docs_release/docs_assets/favicon.ico diff --git a/NOTICE.txt b/NOTICE.txt index c97a8ab5e8..0c3ee51929 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 0000000000000000000000000000000000000000..e3115cf1ea9557aed91461d566fe38a07c2630df GIT binary patch literal 3862 zcmai%cQ_mT7RO^XW~>?^_O4M|jI`8N^)|#RY6U4;DN3mwd%ad`6t!apQHoYc?O8iW zwIN!n)uNP|x9`3Gy!ZX%-t(OE`<>_ce9t+5f0J%n7_%_)F#-Sp7E==g%isU=zlxsv z_ls}L^Z)=r%ccf;h=)sVht5d?X=QL#K3YJ~XI#9~Be%_{hh;<~cMzmCMUv zSvTnb4g6wY;BPHb0jW*~P@Qn1hoaS#yGrZ%@e5fFQbdsUNgk~Gb zfuW4I$ODd=M{8pn2ZIVV^lBiLBiKtCg`Oz!C@^q1!y1LV8ugS z#g~;xfy}LdiupU!D`y$ey<@h)SI%sEGIi^{?@Ab}0Ft>v0>jA8bP3UB=JqxAPMbyY z`xBW<*i3=^FhRDP%r}_6UqbbXdW~EUlSopa5Fg%){joB&^BDf+Nwu;W#!&3(mn}Xl zD_4c5nrXG!XtX_6or5cyORbKv&7k@%UWj&G{a4YMIHL6^eoiU#XzQeFutoVq*46wl zR@V4j+DWiAg4WF_O#VjW8qSDklvcmM5qA}4XSdDV*FQZkW7YmNoZfNb zVR1cZJjG+Fv{a*N-N9yMoWOP=)w zAb!eGm5!x_Yd_?Z#d0)44oWtZz=u>c-s~X`*x_b~9&Ipj({qmei8z#MIhe>^3*tK0JgC?>|pX~&yqnUkH$2R#fc09u|#GgDoT9kWQ>l^;Xd| zMe~GKWm8=E<$l9i3F{E|13HKFH+;Ou{Oxj#kmrl1_Cw=<*bBM)nHPAH!Pn5$7bqOy zR$wM3E3E&@ zGRMV#Ai^e242o)5XUb}Gh{<|T4o0f%kzFu_Bt8s=N4?)DH~BL&$mt>)&4Z)cL+Ka3 z&c(6?ndgc*Y;zZ!yL{Jx5K0-O%}M%{wx_lhjNlT%f%G$mXRf4S*!6`5yuc0+ngiPl z)oiy3U=5Lb#YNK*v216$ToYp+8zocah$2Lvo_=U^ZZuZOd(1`SvRF^klN# z5v98$b`t%Iv`y|2PpXF^Z>b~}DvoEbGlOuxk(bM{21UKyh-o%lYF&MAqDcvIqMZJP z-forlkL8q#&(@oL86Ryje+d|HX7%Xm81LFlPHwoF@9JM&Bg!`Q&%y?S>=kn{SJ@4x z4@_Hp3JC~#Q$9=FwE zka<6{$FHDZRj1Y^W;$9=D4CrRowp5dqAMT?H>jPy@3(&@+VMHHXoVJ(MfbAfemp&@ zI#Mu=^_ZH^Wna-hT=qymhHg-`jGN>&R~tQ-PL8sgB7?G5q$m=EEBHB9XnPb0``zlN zBhvwNf}7|QTJ-!CVW2ucO`oEfhgT`}#rBOcr3xl7Az5O?~6F2aC zcl(I3y+9&6pX^F#9w9R_qjW|j?#$9k=iNN`tS35cxp-DRun~!6%kVsc!vJ=gc4cDc z;poY3(1Gc__)m)wJiR-(w%~;|CeHG6I&@wS^;K6o=bD$0hq-8sm=<;3C42zYot!TD zL!B~iAeuRhmFBwiQ>`+{cAh65$#A`=ks2j3Ie=Zg_$I(Jy#nx6kzyOy;$} zNe{u^<93_0o5&IvB9C)-Mj*YHOI~nEsNQbCsbq8pgHvy|)baXYu4Io)pdk0qO~$BY zQunRR;*V0Fgu#SXXq5W~Hq`NtJddJ|;BXzq@E9IYnbdQHDi>!#)5rtYEAf541CO;%g%ujFC`w4?F45%(;l%z1j?^3+HkD!STPTP}^ zyL17H%C_R)QWPj#{!mspbLm6}sBJQ0aaUw3E9hY8179%l6g;f6X8ufNeDo+;6iAf8 zzI!d-D{4_gm*U;8WrQLSepGu8FJOi20!}!yg=mhp7q`AQm*#i9f0HCvwT=p*@hunq zvD9pE(XP)XN>S35FOw%yDefieaLx;Rq_01y;ZB=~J- zlG+hZLp|OPo3(>Fl7|j}KOg%q4%>O%IKf|8d*NNZazIYALcz*+AeAFc<6CUJQ|zc~ z*0=o}r#X>_209l5EmL{4(7LK*ws(%PE!S=gABp)qx2D;}om43FVy3 z)yj6#@TWiRz()XFr0@Y z;I#Yua0!|Oy-HU5h;0rVbjAm#u_=_WKU!du7L?QV$Vkjc*@Oyq`hjt(tqetLxTl9u zUY&O_B-mT{_7flx4&!own;-MOp@M+KYutZnH@UPw>Y`1^%jWPz zSMM(*RY4pZrCvmNe)s?UgK^-}TH5($fRX=(*X-q(4pBzgI|edb^lH$X7_cbwZSAaw zliApUqN1@cxtz?5hvwL6ebK>jE0?n$4@MDrvICvfJYJo!xSeAg|F+zaj1R0hk1FhJ zOnzFUXyC5uwYCNo*uLjVg;`8(}O z^{vCm8it=iJul^s=6b6mZ)-eBL~dYz(WU74xMu}?E}byl{Wep;j;Qs-(gUSC3?9v! znY=g4m6Xyg>d#?aecR=3(lBXjA!5{kyrH*O?Iy`(ew~p}9Hue1m)4dD+yc1G% zUb5nap|DE(HF7TS_T76@`rpn}*PZYB0gs;Kj|j(tA>PK;EEI<~ulXLlu@>T<2S9_Q zE2iDs86s2Q^#qM&Kh6_Y*kkACU8JBv@3s+2zKEH{UZv5{Z z^_e+pTTa|AD^R)q0`|2^VTw2)fxqyLe(Eo}Gx;AS0;ZcHC|DD>dLuDqgb?}}n2_@4 ziQj{mfp5oJy3v>F$B$>+BP6HpMzX#WuunbimMmP8*29!EIR53)C~KC#4O=G}JvVnw Y;FoI{~I#??``^jY|{Um z+yDRnZ|OH}2~bwv)5S5Q;#RW6rG|-;d=dwlbk-CcU=mA6YGhVR@?l|+&tzy{|3dTz PP$`3_tDnm{r-UW|zKSI- literal 0 HcmV?d00001 diff --git a/docs_release/docs_assets/favicon-32x32.png b/docs_release/docs_assets/favicon-32x32.png new file mode 100644 index 0000000000000000000000000000000000000000..1faba7e251c605c01c540cd88814f3e0c824554d GIT binary patch literal 129 zcmeAS@N?(olHy`uVBq!ia0vp^3LwnE3?yBabR7dy5&=FTuKz0;{x|af?@|3fQSbjG z{r{VC|8LIw|NnpC%Jy$SH7cGijv*Ddk|pLPi1aYIsjX=cT-PvFRy$$wa;7x1H4Uj7 bSd`vj?&?ApMyTNNp2{|Bv$e*xL|Hk1D+OF-}mD6jbib6_qR^Go;qm2=u1o&dkkfs->oU~J~VTtXeB z??Yz(1#@67x#s`$Jey_jyTAMVZ~2evz8L?0wPySq|1Py|`Z4{Oe*9{{_&5GtG~i-u z^S@v18UMz=)vsR-82`q%c_|KIC(y!X!}HUrtos2Sistw1rWXz$a~ zyh>QwP(#9&OuW?YwAcd?DH*~N#8Z8|>p)hreS`c874jIZBM>7I!B?P5UR zciz_~WscaZaW-wj~~AzA7aaE8Hf09>Ok`^aCtRc&?kNO10n`M3GU_w#pZL145UT&Li&M4)J|Q|N!qQb%izqN%@?7db&2t~JmOCEat& zeYgF9V`&rFUhsTj52zmjwQs$_F&rED2y@Hyu`bmqmF^O%pkt=UKVYu|$oxBYPW5cp#a4qm^h2_av{4Hk8dIRF3v literal 0 HcmV?d00001 diff --git a/docs_release/uploadWebDoc.sh b/docs_release/uploadWebDoc.sh index 896bf3a7d6..2a23a3816e 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" @@ -290,7 +293,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 +368,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 "$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/" _ "🔨 Adding things (~ $files_count files)" git add "$DOCS_DIRECTORY"