From 2951e8fe2ddd5e64272dc8d3e949f054ff319b78 Mon Sep 17 00:00:00 2001 From: Kelvin DeCosta Date: Tue, 14 Jul 2020 02:00:36 +0300 Subject: [PATCH] [docs] Add MkDocs --- docs/assets/css/mkdocstrings.css | 33 +++++++++++ docs/assets/images/favicon.webp | Bin 0 -> 3626 bytes docs/assets/images/logo.webp | Bin 0 -> 2050 bytes docs/overrides/main.html | 22 +++++++ docs/overrides/partials/footer.html | 27 +++++++++ mkdocs.yml | 86 ++++++++++++++++++++++++++++ 6 files changed, 168 insertions(+) create mode 100644 docs/assets/css/mkdocstrings.css create mode 100644 docs/assets/images/favicon.webp create mode 100644 docs/assets/images/logo.webp create mode 100644 docs/overrides/main.html create mode 100644 docs/overrides/partials/footer.html create mode 100644 mkdocs.yml diff --git a/docs/assets/css/mkdocstrings.css b/docs/assets/css/mkdocstrings.css new file mode 100644 index 0000000..a7054f5 --- /dev/null +++ b/docs/assets/css/mkdocstrings.css @@ -0,0 +1,33 @@ +div.doc-contents:not(.first) { + padding-left: 25px; + border-left: 4px solid rgba(230, 230, 230); + margin-bottom: 80px; +} + +h5.doc-heading { + text-transform: none !important; +} + +h6.hidden-toc { + margin: 0 !important; + position: relative; + top: -70px; +} + +h6.hidden-toc::before { + margin-top: 0 !important; + padding-top: 0 !important; +} + +h6.hidden-toc a.headerlink { + display: none; +} + +td code { + word-break: normal !important; +} + +td p { + margin-top: 0 !important; + margin-bottom: 0 !important; +} diff --git a/docs/assets/images/favicon.webp b/docs/assets/images/favicon.webp new file mode 100644 index 0000000000000000000000000000000000000000..e660e9358550e5a8fc5c005a5f3e6c3faa3a5912 GIT binary patch literal 3626 zcmV+_4%P8eNk&E@4gdgGMM6+kP&iB#4gdfz|G+;G=5X9Lk|Rm^huvmscF%kxVgmRp z-6uS~=RGsf5iN7(bGm$q00+itWt&+$vo^{3j^4pE*i$#qa9S7(Ta(P+uMLUSs!U2-+HpK-s;kDYWZO32Fp{K5irQzi z{%3l2;9NTXe;wPLolR`pcIl)V+qU&;Y@4rb>v<=e(5rLKeO>pvfH=8hqqFX?oI0o` zwo}b6g33;n4Y+<+kT$(LqqdVB=yY+V&Uz-k!_J*;m$QIW>9YjZQ%7qUbg|3%Oeb3a zz%r7)$+nHNZQHhO+j_NaW9+(3(==+@g&+W6+2}_$XY*{^wr$(Kn{9gy-^3`ABt;9J z*1sM8(_KP>B)M(VBj@l2Kv2TllAnwHcTrlFh#usqGxW!jF67H4g-hBZWtYNb8K+G7 zuQOEl|D68!OA2!Iv=wSwAwQVYw7kK|^MhT==Lb(P34Bqx5QqVb0AM|DTIo;{EZS0sejbODJCunQAfE7`Jn3qOlrcA6U((kOxuwo0-R+PeC0{|?v*XI< zwgM;lN0Ip*Tb5oW-iV{iCh2vFeJdSb`c{e7>j*=wBl>cT3F+taT_|Ghm7p2Zn#33} zi8*3oW5m%biT{aM6}$0`L8EJ}Mps)5tyD{rtq|RYhm4`MD(;*T`|&HJIzwK#V-Q(k zP+6(x9Gf|=`pO9$RExY5*{+zj%rRqX3uk2Vle~pjZn(t^sU_3%6+VPaL0qu#2oWB0 zMHlV|FY0k7rzGKVoU1P*uHFw@MZJDNn(yqafRYqmeB{QNC)dr2|A3QhyqY$WM#9wW^ zrWrZIG)2nuJc+X8j8DbUiM}KO4D-lpBkaS+Gpg>+D`HnOAZ0bnHO7ai{s4rc&awU^ zi6q$yxSnZ7wNL^)n__l716X#G!`kWBl3rnwNEHl@He;)dpJ0Ufeg%Pw0WX&&U`y|i zpnTHQ5!4&L?LEhX)}JKSni(PFviJ;4*-REk_KGQr`P?h0+Q#-2=0~NnW|{HTz;D_F zDPXxRAp=)aa-vO;AlLY#j=;kfFlA4ng$wIe>Xv z5}&M6DbNqe0G80qJ0#&vW<4&HKFR$~CI1oiz66zZ=dB+h(46Y9fOe;j_V-s$FkK~_ z6JMeYrBrd?77DU}-N=!zhWUybDyuuTq*qoWnRk+-9P4D`-Wo`jLmEf#V8=`t+U+8m z`JZ`y#SGU~5kKfh5+mOowasIRQLMYr7i*|=+`T4whjFkSGh;->>^cPNZVLF0 zdCJOmXG;zI3T}9%j*I8O(InJewe&yv`~-dsB+2=U0LB&K`{38zl|XtW61+0!OD*zl z5LpQ_{y6glj+rvoUDj<*&oCeb;}9o$u{JqlI*zWj=n;>>6qSWyk2jRL?v~x;XiN^V zVtv3o&#G|FBXK*dyR6jSW_}?5FtWy7qlnt@?6CFhW?su9*M0*X9AJ&l33t`IIM0i0B zv`zR41)&6rxwAT6#d5jR7 zsTTvDc=6dOoBG%qyGs5mAkQ6~=#M3ATdvPJnmo+ojfpoEb+1u`=l2~BllANJg)C>? zg_CjiHxhb#s~PKvz)^(me*x}(1I^VHqRl&+oa@d?n_BqlOEps|UMYYWL?e41F2;G+ z@^XU@DArvhxbNiEFmJBdY+Kq~epON~@3();cpjWe`i zDSkife1F(||NXPkzZabJVQ60HgJqZl=UOHdIqk*`Xq>_OqnYa?4TsyGN|X+YU6n~| z+#YG16($Ek_Zn=5u`*M78qYX`&u1&!D{rj(X6f-%Z~cjBO(>2*xx)um5dpZ`nI4fM zjMDmu9nCmHK**)ZzH61nuFwHB*m4H?sR30d+b^7ZNpRnJpWLV5gwNkPtlBFMzm{j8 z7Vr;B|1SnpH`_0ixiO`f%_f*SdxQ~DVZ;(0s6^@DU#4MvH$QrhLHS{w9spI6bryY2 zhV}MK<+ALYqQfg)GpgmOM+|DxASH~s*_nsp+jMdLOj5iqPa*g94|P;_SKc7@Us#0M zEW#`nA(nlkzrQm#J_nelT8FkF_A4rkT%_YP-g70wiW2dDBQW<@*I98$$JQYdM5)B< zvE*{w8x=+`LDQcV4$+$LLcub>qJxfCXVsBN7(+vPyH%0&=F!?Yt}-(2Dx1kzGkj{`w&d2IqL{1ifRrd^WUY9poK=%H^4Xz;RDyYuDES6#6 zHbXt!A^ZNKLo?P=ox!zJ53Z}<9P2ID=y@Q&~nZzkp$OT zya&UgWrE$ccLJQl;gq#?@Zl#AZ_^4g-cW9Tp*$jCOb6&E3qLN%c!Tl&LU}L;Cw=w- zX@25?(8n@X-)js+xCbe2|_%t7Ea9F{C?P3v`var-Bm}v7vg&BcJ}iH zNQOB~3tN5l)mxl+5M!dT`syYaBg8s`qIGqrB9XqDvVRUSVRGsWB8cjD34wTDp(bG# zqsSDDK#pF*{sko4`D>yO6GKkjMZWX*D08yaY78y!P{QRCB;EOoB#}~gmF@Yo6`HH! z4g@LpV8Sl}$Ruph<_eAY=W-h`l&L~>h5&EG_Y3rWm3JW)%P@d^BZzsu{{iy6U4Nyi z$0r|Jay}N1Z0*FM*GP2EqOxrOFn9W?)qN;uFA-a#8^}-2?*Vl`XH(%^@d*QN-+|X& zbN>z`Ccc&!#TaUT&Z?`H0^LAH>N&eAm9(vDnuaX)oXta<0sN=Ye$MJjy-(YwJ=JElcC1@>2Z-~tuh%KG zMX}vrWMopG$ryOO&Ynf$+8;{~K0S!%fdiEL)rgeK@_&PrPD@GqqV(C~9L)2+ w#?J$IIzN~n%x|$|WYy^&AIU}p`~T1IcuW4d#L|?DZ$#Iztg`Nk&Hc2LJ$9MM6+kP&iEO2LJ#spTH*&e+Mg)ZP&`I9Zqx0Y4cbI9indD6tcY zKr|hC;KAwWC60)tHf2~ZuW<|=`{k%{`yVaVi;o+k%@zd0YVmQ)=@gS8XOk4lPz@h9 z?+x>fj@z-FkM(%@yOsTX`Pl!pU5?-XOFh}omwK{n|9j_x z$W|oofB)3ahk9J*@J4HkM`>-6!d#@7!!2?Uw6;XH$d+{)ed&G4GR)zP$R-zan2Sd- zm#mXHq?p4SQkWylAQy?qA+kv!M`Zh2e=2b*p8CBgL#vZT@hBcm3UiFXHU^tVGlvve zCyD$0+tNzDJWID3%X7IS2)7x_W8Rp#Je4~FQ%SWEQ}ZCWy#<5_*VN_xe@Ou&vk zS1hA>TQ;m&;t#-n#uhvFUq z>{m97A&8@f9ru7h#;sn+3UHfymWcEJqec)({l`)!mR6o^Bj0uzGHUeTV+b(uRX(w0 z?2MiWV9v>LD{2CoU*%ODj*=<@m~-;_d(z`H4~OdCH4p*}e3jQyxDddd zlcOI>Zu4-oqJ2e+J13Vu4BY17KqLDiz{pp#a*~q=A28)8`}x-1mxG+V`#j<}58L}> zybiA^CI?qeYMENm9RZBFcs0gC zDDPIz%qW{RwG{&Ra`Cv$B?nVwy=uovJrKZ{i)&nRaH#Y-lgkjmmy2r!E;*Pgr%co7 zR|x@pxww$vl7p#ocKaiwiU7V`oCvt&;3l8Ne+${TP{8Xe##^VH!I#; zJPmwzir^>qIC1FweOez%#}q`KXZA>*nORAum^vxQIY}FxsXcti1%x`P{g?| zCbxcn{o&)QTm+c-`f~U2lRG&Gu%Ca$QpcQ&BXaAn-+A8}pA!NMd|kg$`1R3ELV*4J zE0QFpSAfi|Z(a}r41L|ZMF?;^|GGi-GEliS_2v5lLV%I4l-m!B2?1{BUmKWS3of@l zeV4C_03%_N z2SR|;`PZ^>FAbktpZyGk03%SaOA_7WsPQ)YV|lAxx0F|78m z(0ef!_KN8B1uRoF-^-%Bhh>);X0MIW9+soMHs9d0hvjN7(EB;rJuIutv3sdx_pr$9 zrTPllJuEVNz25f;?qPACi{?33POmS(d#;@ATt3&nKys3Jy$0g-LWtL^Azm+uc)c$2 z_2P)vD + + + + + + + + + + + + + + + {% endblock %} diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html new file mode 100644 index 0000000..84e6a98 --- /dev/null +++ b/docs/overrides/partials/footer.html @@ -0,0 +1,27 @@ +{% import "partials/language.html" as lang with context %} + + + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d03ac43 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,86 @@ +site_name: Picharsso +site_description: "A utility for converting images to text art." +site_author: "Kelvin DeCosta" +site_url: https://kelvindecosta.github.io/picharsso + +repo_name: kelvindecosta/picharsso +repo_url: https://github.com/kelvindecosta/picharsso +edit_uri: "" + +copyright: Copyright © 2019 Kelvin DeCosta + +theme: + name: material + custom_dir: docs/overrides + logo: assets/images/favicon.webp + palette: + primary: black + accent: light blue + font: + text: Nunito + code: Source Code Pro + favicon: assets/images/favicon.webp + include_search_page: false + search_index_only: true + +markdown_extensions: + - admonition + - codehilite: + guess_lang: false + - def_list + - meta + - pymdownx.betterem: + smart_enable: all + - pymdownx.details + - pymdownx.arithmatex: + generic: true + - pymdownx.smartsymbols + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.tabbed + - toc: + permalink: "#" + +plugins: + - search + - mkdocstrings: + handlers: + python: + rendering: + show_root_heading: false + show_root_toc_entry: false + - exclude: + glob: + - snippets/* + - minify: + minify_html: true + +extra: + social: + - icon: fontawesome/solid/globe + link: https://kelvindecosta.com + name: "Website" + - icon: fontawesome/brands/github + link: https://github.com/kelvindecosta + name: "GitHub" + - icon: fontawesome/brands/linkedin + link: https://linkedin.com/in/kelvindecosta + name: "LinkedIn" + - icon: fontawesome/brands/instagram + link: https://instagram.com/_kelvindecosta + name: "Instagram" + - icon: fontawesome/brands/twitter + link: https://twitter.com/_kelvindecosta + name: "Twitter" + - icon: fontawesome/solid/envelope + link: https://mailhide.io/e/c1R8e + name: "Mail" + site_image: assets/images/logo.webp + +extra_css: + - assets/css/mkdocstrings.css + +extra_javascript: + - javascripts/config.js + - https://polyfill.io/v3/polyfill.min.js?features=es6 + - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js