From cd8e0fdaf3914c60a9f6e106765a5087a838f2e6 Mon Sep 17 00:00:00 2001 From: eecavanna Date: Sat, 14 Dec 2024 22:03:41 -0800 Subject: [PATCH] Customize Runtime docs site favicon to be colorful NMDC "M" logo --- .../fetch-and-compile-runtime-docs.yml | 20 ++++++++++++------ pullers/runtime_docs/Dockerfile | 10 ++++++++- .../runtime_docs/assets/images/favicon.ico | Bin 0 -> 15086 bytes 3 files changed, 23 insertions(+), 7 deletions(-) create mode 100644 pullers/runtime_docs/assets/images/favicon.ico diff --git a/.github/workflows/fetch-and-compile-runtime-docs.yml b/.github/workflows/fetch-and-compile-runtime-docs.yml index 0c8345e..281ff51 100644 --- a/.github/workflows/fetch-and-compile-runtime-docs.yml +++ b/.github/workflows/fetch-and-compile-runtime-docs.yml @@ -40,18 +40,26 @@ jobs: mkdocs-jupyter \ pymdown-extensions # Note: The `mkdocs.yml` file we pull from the `nmdc-runtime` repo sets the overrides directory to `mkdocs_overrides`. - - name: Copy files that override parts of theme - run: cp pullers/runtime_docs/mkdocs_overrides/main.html _clones/microbiomedata/nmdc-runtime/mkdocs_overrides/main.html - # Docs: https://www.mkdocs.org/user-guide/cli/ - # Docs: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance - # TODO: Make the `site_url` configurable (e.g. via an environment variable). + - name: Copy files that override or customize parts of theme + run: | + cp pullers/runtime_docs/mkdocs_overrides/main.html _clones/microbiomedata/nmdc-runtime/mkdocs_overrides/main.html + cp pullers/runtime_docs/assets/images/favicon.ico _clones/microbiomedata/nmdc-runtime/assets/images/favicon.ico - name: Compile source documents into HTML + # + # References: + # - https://www.mkdocs.org/user-guide/cli/ + # - https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance + # - https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#favicon + # + # TODO: Make the `site_url` configurable (e.g. via an environment variable). + # working-directory: _clones/microbiomedata/nmdc-runtime run: | echo '{ "INHERIT": "mkdocs.yml", "site_dir": "${{ github.workspace }}/_dist", - "site_url": "https://docs.microbiomedata.org/runtime/" + "site_url": "https://docs.microbiomedata.org/runtime/", + "theme": {"favicon": "assets/images/favicon.ico"} }' | mkdocs build -f - # Upload the result as an "artifact" so it can then be downloaded and used by another job. - name: Save the HTML for publishing later # Docs: https://github.com/actions/upload-artifact diff --git a/pullers/runtime_docs/Dockerfile b/pullers/runtime_docs/Dockerfile index 507d2bc..a88e954 100644 --- a/pullers/runtime_docs/Dockerfile +++ b/pullers/runtime_docs/Dockerfile @@ -33,13 +33,21 @@ RUN git clone --no-checkout --depth=1 --single-branch --branch=main --filter=tre # Copy files we can use to override parts of the Material for MkDocs theme. # Note: The `mkdocs.yml` file we pull from the `nmdc-runtime` repo sets the overrides directory to `mkdocs_overrides`. COPY mkdocs_overrides/main.html nmdc-runtime/mkdocs_overrides/main.html +COPY assets/images/favicon.ico nmdc-runtime/docs/assets/images/favicon.ico # Compile source documents into HTML. +# +# References: +# - https://www.mkdocs.org/user-guide/cli/ +# - https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance +# - https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#favicon +# RUN cd nmdc-runtime && \ echo '{\ "INHERIT": "mkdocs.yml",\ "site_dir": "/html",\ - "site_url": "http://localhost:8000/"\ + "site_url": "http://localhost:8000/",\ + "theme": {"favicon": "assets/images/favicon.ico"}\ }' | mkdocs build -f - EXPOSE 8000 diff --git a/pullers/runtime_docs/assets/images/favicon.ico b/pullers/runtime_docs/assets/images/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..dff6056f675c564167696b0b5e400b14a2c780c4 GIT binary patch literal 15086 zcmeHOd013Ow(k}<7DYq^L|Fu6-*-^r9%xw;qDGBzn@OT(G*M9mq*)Tf35$YgSvnJhS1hSF8`k*7=+DU-=uUA50cWU`BRHv}dB{&-)R>{)!^jc-szHV?$_ z#pR(X{{Qd4Zx6JbRrUdSwVW$h(D?nlLe(~l!m7>kN2|8*L-tS!k z(*n>6pV$F=I{#LR z@p3eUJIy=EENrC0&)-q8*w<0<63Q1tM=BnhIC|QcqWH8vrs@H=H>j!?_?x(`Yd`%p zu;I{*I?PRiouS6Va|rVQIPSZVX4j2*qH};fh>W zyTr?*Y!ll@+9nc{^RUErkKu`xkYnXTzDY)H0C0zc8he4iU5nqh@$l>#)yI}py<;df z9b2ryepZPR#Imp)KRgb4g6}Kw&czV_7{?TIS3AWkz}+U{HY{C+CEf~hQatl`Xi6s= z0Ng>Kx?bSF#Td}f9>8>^>FA$<9rz^7Vhn&E*z5L=C)ge6k|ouB6Mw$tOwI^H{H}J> z<^u0;hL{bXF*eO1PKu;X^)>dsx)=CcH29S+z|4Ir`nu`Z63pGn)Ntrw$bxxr;we&X zx4CPJw)8t!{n?1&`uu14Cy(;9R~$FQYU;Glai0y+Zv(j9L6>`hUoG&TD;NR% z7X;SRYpG_ZyVllNP~(vWVjk;kDb@qk_Q5CByCa55yy?|B@&!T3MPuw01$xcdyGLofkKmj-iPzMdVI8uNHaO4VpP&0OsoJAacvE+b}BSipW(H(et!aVXOgtuVm{jn{gLJ{j}hj>!R8aot+=i-F4d}F zZ0fdU;VA_B(zE^_dOx|2T0jxW6%?J(@O<=xb!OZaaNC1Qdx8Hv*Q?(*)u#3f@8dPQ z+%+}^_ENRoS}TK`>JKF8>}k`9<)khS-mlu)PuM`irD0sqN?t8}1^kr;nowf6`DjQ%w z*$ez97(dq8LC}dqV!hJZPM)`_tphbCQkNIkaxp|QHZaNtl>n=~-Jg)uHSJgLm0|Du9vV&WqIhM>NwXT)uCSC zKg9T}wwPH!C-ÐWC2E0I$Ri^d{7^|bk8!( z_D?3Pvj%#UK+cXcDP+$!!v5!*X40Dou8W9_i18VG8n#d>1%7^}9}n z$OqIn-Ii9hVhp7HWq0L14SoxA*qgnuL%5eDqxykXA z7n`Efdqey@1}h>{2>Tq34A2`-uN;a@yWBPYG&R{zuB4G`u2K(W*vt4EzkhUK)A40{ zc%Q@i-wZp{cx0i#+>G_O^+s!hC^B75L&Gb`Chcc(E$Go0>|y*^n+5{+Zh@Wm{Mi4Cz4X?8V$E$nxdQm} zY3~cOC_BuXa>66J#m{o&L5~z(Y3%_qTY%lP-st1E1^$6SW#sVqrJjs|2LD+l@GE!o z8ryL2LCn`aV$MqEu7(4NRKD{m=uIeP1&x6WfxvHCe{^GjZ&t?5*%h6B<@>Jmz61V< z3hM7uN>=d~Xw=$n^{5m6`h5u+o2l_TXyn)xMgREoRABd_HG!i9^#niUIA0Vy)h9Be zc`7j0NjOcFtUtDl-?x+o_?6Po2fNiHef)b^e|Wy~d6Cy$rs|K)X-`oUbjFXef<0-K zj|Hs>aOg?@w*vn{)=%I!1LpOna7*tc{g?2Y2bYoK;x6?_%wOn@IcP8AXWP?oc$Uz6 z^;h0h`rngi!{iWP_omhUcC^w<2KHq^9}4xPM8n+-b3gO_kE_XCFXBPSN(qz*dNo! zE!_hn>(NG2_#>eIHeuyD{b%e<1EEJI?9q4JHrC%k*e4ujeOG@S4(xeU_Q{j9exgQi zvVvS`rFS3E|7!xBF&EhWo3uY$fM1*qB;5KXu#W;AF(!i!zZSQIU+B?T*rTjY_UH(= zjs1@`Y~@k5mwZOA+LJ+>9-T;QU~krjc!OYf0!9eC!_Qsd{{`5?^zj-=;Cc z*UKn31bXgg+Yvu(XQtm^%wM^%L(14BL;PO>zwS(Lh}rNN*gZi%>dO$G3j84#gwE@9 zM}I6Z29`1BY2>Oak_@HXF6QfS%-0`(`D8r3Fj+<`JY~>#Go8M0-}Ab~*u@<7v%%hA znm+zoU>9dVL!4bb1N%Zyt0Y4h@DJ_^zgCZiBvz11UKQ_6FLL`gekyQmJh|@twoC=) zsJXz%I9K_Y(^~X9<7d5LnKbyVfnTAI|2g0{>DM$R18`e`wo3RzQ)+2Ya2NeAjfHsm=*wBbY;U}v-?kWs{?Z|AzUi)t~FYKC?TF-Te;ixuEvo=l&-=jNA&%1>R%5>dyF*My-NB%wYO)OMLH}#4A#s7K?zg?)68~Ba~YFVZh%Y;pcrO@6~v( zkm)-Zwr6CAae)4`=fzCTx)+?L>Le|^KEOAj>h0d>&jA0@-?+V;@KC$8A-=~o_{V7N zJZvazkRV}8opdtfg!>=LiS52HBjM|^MBl>(Etc9^7ZorZXOx|+ zE7Cfp>woQ9kR9qp8xtZvEPigL&i5?U|Gi49aTgr0-~758>|_yn{#~2oiyd%mm=fu# zjQ03&wQs*0`q=qCE6Ap0!_=_9f3!?tGH&-f%HU}pTDE;aK@>eo_<)5tfmG8(2HhXd7RM#mxvS$r6R_Bj+XPr=CZ5eZ6hDG@K zcOXj%%5N-VFT7!Wf5kM1$1Zhiv%k)FkZ+tku!X8Llw&&sIZJDgqg{W!3$HMnuG@jpE5wIWc3kn3y1U&@e zdoRS`OuuAZe@fq?{o$ZfMtDnD$~oT#KC=MiH?v-fgX)gNT zfv+#9rVIXUw;Rv)MQnRp?Uz32`$rHHDAL4K&*TdJ4c|>~Z$7o^VX56Qj_G}!hbf8> zkG!oPi{$vE$8g0LF)q{Wq;J8O^-R?T|J#TiA}=rh1CCKNpL|;6HgJ9q{0<^#rfN&S zwwljJiF_t*H*DmzNyvGr)8{SS1H&En5!09J@$W8g;TnJ2bZqHc?4zvvW~>@J!leG8Q{Df!sY-mLY!Z#ot42XVA}G$Y0OjVZOal z^SKLhQ6>of)t}g-FIFIDWhrP$EA(?Re^)dv^@-`eNw*|@K_IUdv){Xkv9s0~#dH~*;%{+F0PV&pGC2ZWCpIXJ>U&oNq#86x-V+Qql!6LX`} zU&Wb}I0iVy!ypF8@xY;o!FsHu$dpPcmbTY_Ne%1&nJ)PM%=|ImH#8iYDdcVX;W79c zEeN?2(8U>~{?fB?>tet4h{=nXFvsv#A%=%MpSy8LjJu2DEDD`+SU(ol7BNe`5xl#a z{}-75)sJNB)x}{NA35e7=aPsq_%5BU?0)3d%PEuU@?z6;ejSd%EecL1*Z>WNVbjPz z>O)Cx9)CfR8R`bN%&Mj?VuoeRANu_a$1yohg|QHN(1=(A&%>Sh({ZN0U&ourK%!)? zB+>7l-gy+2cC{1#2>2ZxQhy<5jZaImdHUr~%pbAULLPs%cWiq(x9{57wRCRF5-N%h zp>@%n`SUoeiAtu}G4t<)CY;jmcb)v~x3vi`C+ssNzo0&EzW-6fKfjQ3JF7p@% z^r5T8sr2TY2{@y>ga0JRe7FB4`SatFug{-Q^m^2T4VR@p*Doc%G0sFZa;45UsgFV8 zU&QfP&Ou;bJ?B^K%nB3d>P+~Wa--sn@&}Ihvd2Aaff!&G_}Asq`_h-&^OmXWt%=!-@{$Am$(X`~}2H5MP@Mea}F@!!L}uLZ+{Ui1ENDW61v_ z@b9oE0be;N57aJU=;U_?2Atm{A1})<><`wMmsMM3^!@V=R1nAU$h*F}tYFr^$@=^& z!P}^R3w-TC`*r+{`OVo!J4g6vnZK~V%}3|`NBMj9^!!Bj@7wA8IjjAKV*LBTHxeiD z=U9Z;GfDk!Sb{gl;u;u(QNK6(z&sp2)@7G@PKx!X;dt(*&C8-_#TfR__Z2>E_VKZw zjC~%t5z!KVjwRR_^3;C@-@c%inZHTDH82dGSk7_qIvf_{Ulcy{o-)QC{00erJoc;u z>|1Alop%1I!MjJX0PuE?d9dzmXjgt`j05r^T0YI4)vq8fa69|h*f-1Zh>pHxAB_J* zmVYDociLm>%dUSPlTp6_e&g1z{NCmvWw&y|W6a^>`}(er(j9WUcEAAnPvwuzaMf?W zyZcFVnyvg3RolDqJGK|Z&z7$Z_1(n$x!*-B7%|CAzaj9;u}|ISW^QD}{OQS zeU<*Dx8c8emT?!xN0{YB`8=`4-}0)&f0d6}TVAyL{?{_b8J+9KRlrHTu<$WNu4IVP^$_L8^=FR_4 z#>(Xi()lU+;=#yut?WfxoDs%hZ|Dx+0K6flFWB~hAkO;_0S&-;!U?&(AFIEPY{GhX zR<+eU-c)UTZwAT%@!9bzs1W%}^VPefZ}C1EdA8WAWxUDt-G(Jv;QTogXM%NJ_KGNe z=UQ0J=bj3XwAZ+X{QJc?)3s^Nw#l52@UEzDr&x}2Oe>#daIP%(uuJoIeg2v&>hk{> zN%e2n@4J5i@|SPdelZ65k115YH};LS(dqu-qZAi)`GD95`vkqZ$-Cf=2kKtbtA7LM zm^sLOyTv)T4alFYE}pna8JqG}h7b0z;{1@nx#P%ZJJ}RAuW}yg)Zt2p{r1p@&!nVltDp8-~-6LjSBA2_la_VcP8>iQQo7`HpZ7^+n zDiXPR!B`VCdvWYT&m~MNc?tVa5p(8scSuw@IW7@vEcc-r=ewEBKP2pFu%fSGo`{ z%*48VhvUs$A8QoZFZ}iTo3kb?$&GNovl=;0yiR6^1@T_wX{nx6j+@ai4DrTq1_f*5 zjc5Zl=Qh^3C$fUv+gAGz6YE<}c<^4-x0UMYm+liUCt}@blC;K#Cf`@f|BmS=-7`^})4J8wrkSHHF`6XCSD)Ai?zI_SAb^ixUx48iT literal 0 HcmV?d00001