From be1644e477e4ee9472939ddec4a6b98a6a477957 Mon Sep 17 00:00:00 2001 From: Shunsuke Shibayama Date: Sun, 30 Apr 2023 22:35:52 +0900 Subject: [PATCH] docs: add mkdocs.yml --- README.md | 5 ++ docs/assets/pylyzer-logo.png | Bin 0 -> 11203 bytes docs/assets/pylyzer-logo.svg | 95 +++++++++++++++++++++++++++++++++++ docs/editor.md | 12 +++++ mkdocs.yml | 50 ++++++++++++++++++ mkdocs_build.bat | 1 + 6 files changed, 163 insertions(+) create mode 100644 docs/assets/pylyzer-logo.png create mode 100644 docs/assets/pylyzer-logo.svg create mode 100644 docs/editor.md create mode 100644 mkdocs.yml create mode 100644 mkdocs_build.bat diff --git a/README.md b/README.md index 183ea38..ae43131 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,11 @@ pylyzer as a language server supports various features, such as completion and r ## [VSCode extension](https://github.com/mtshiba/pylyzer/blob/main/extension) +## What is the difference from [Ruff](https://github.com/charliermarsh/ruff)? + +[Ruff](https://github.com/charliermarsh/ruff), like pylyzer, is a static code analysis tool for Python written in Rust, but Ruff is a linter and pylyzer is a type checker & language server. +pylyzer does not perform linting, and Ruff does not perform type checking. + ## How it works pylyzer uses the type checker of [the Erg programming language](https://erg-lang.org) internally. diff --git a/docs/assets/pylyzer-logo.png b/docs/assets/pylyzer-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..3d2af21129a0a344dcab0797a3f73340a6a35fe5 GIT binary patch literal 11203 zcmeHtc{tSj`!^}-OKQ$I(XpL4HBHu*6Eh|{$Ha*;;f#HkBqR(P*{W|DEu6BJnIW1c zgsjP$qB2CNgiym6lPzQ4^4uT#KFf7Ie>~51{r>#@k@zg{&wbzT`+nWa>m75#%y{#^ ze)*S(h{)!ne-SN2MAngze;dW&ipMMMv+&=hbAQwXRvDAUn za*DTbdW}<2NsJYrYEe#*es*p*=|=NKvBruIAGl9S{o+VR>Tm|wV^o3gs`f^Ee@lq;|Z$R5vzbVDm#FmwD(-C_c}&(+iGDF zpPl{vsN7ZwyT8fZbV6&2ulFnS|C0SYE2Br-+f~ zG%uM%aKNvBai7rYjb+K)>azw>@NxR{1IzhI(zV*Qw~ywJ!pD1Q=e-3A&&meqQrGwI z$B?ERA|eIrpUHXfV(wr`Q$3qmVj}(Vlb3{bO$nG#4gQoGYrjb5WTyM8>II@;t5mX( z=%=XrP2SH8tBC~*FrovR$v>_$2v0-F=aUuR;wQ~~V&Os7-;S1eF>QV9@dV7lBh-vn z!uKq+h#4S5{n@;zf zw7`;(d(nl$^~Iw+=LJ^7m$n^p61*6vqu8Ao(&6ra*l1}bLK$p#e>$O6E!jbM@wy6E zgB2*^9zPnA@jIw-yRF<3lP;Fz-loKhVIJ*BG84H$YVLfjn`_P-N^JOzP7w9IFgVnD znUpA9dww@*>LuCQu|$JkmH~QG==jz>yqMne0#=b`98D(y1itC&-^C)d%H!o)_H1jR7Uq)%_;~GB>UZiE+B1capU7p#`3-Dci*Xto4O^-GCBI?6m}+ z(8TVXG%GfvX2@>aW|bfF*Z1)Cc4RWBpVs$iXp?pD;l+SFsq5`{5c)L-{k9bCnYJu+ zhrQ7UrT(!fFQQxHID`?`vdHep=uT^5aFB@*H$MnOxepX(-CC zt93Ix5pZyPeX-xZ2{XO&dxTaAWLae;{jhIZCebdiao0=)?vf~f5Ae$&-Jp#99Q2XV z-sKmjs@$ek_iqR|R-Q>Pzw7Fs9yB~GX~rD7Atbt9t-ttzr&IamogoP4#6e%7YDm5< zSB=vT9iLpgQm?MjbI!`7ARjF1GZK25z-pCL* zABtQO>?n|WCO7{;vB#3RTZI)C1b@yQ+m$FJ@x{?!<);p&RD8j0x+1LmL?+wBZlXMUtUGy+ur~zf zxyXq6kelzP_cvb5{<4rL>eRTdSR-=fV?jQ_9=`!D)j2qxt2GWbs;e;Ni@ZGL)*JKG zoSBm2Sm6}rM^r~XX=>70i4M#p?6t;K6pD2{sU9m)Z;FE#SqW0t#eD4#`E%brF^zT^ zKEX`c-&ZVVH#-zh>RmY_*y^LmK?epl?5z3zfi`ym@%MgC?7RgtCAGeuJYFP*cfswN zWD)in=Z!>}=~CVD5-@|iJo7z7?PfDojjMz2Q#O`v1NHyHvS?-5h^H%YaMmot$0fT- zP4&z}I^#EKfhHjK&Yjl5O=-fq%CbUO)P_E9$xK0mt1s?~FNrqsbQuPf(6DY-qQ&>d zSIRZ~J8ig+p$Qm#2xKl#;(#fl`%Zog6?5$bbLbP-ErLYsazgwc=Q(L618(^A$_B*S zErfR4IPi!=bHiiZx24njn?FvR14WO6qMuWP4-YF{7`T;R3D{~6xXfOK5R|_;`0B^9 z!b}BTj2W36K=XNTopxn^}0jY#2Z=Tx~E{*{@b_J^f&`69YzMwVsy%*%{<`i)R1bR#;L{|DZtt_g|W%+T!e11il( zC?#kA%Q|@VqQzarpFWqUPXSVT??N~31rXWaY-8{@etjh%fOkM10?c~Cq0Cu*=e28U zNl9mQ)l`xYw|tqXxD0vswxYH1Z!7wu8bu26-zQQPb6-?b0T}wKTK$D*$Kyp0G@L7um^J8&OMRFhNRx<*c$@CYGb*t_Z3cRq?G{v_Y zKyPq0$vxnn!`Yn2y35F|_!!t0-}$HG;p5(YYK(OekXDW##U2lcRYP2T*P)caW-v!f zCZPapYN}JMr_zj6D2kwXlCbW<-|y=X0rNfX)j%!=L`@IEsT@MIM%KwjlwSNEQgh*( zpJ{Yd2S7uSq~_e~W?J!T8ny`VFs|9@e9FZN%W7aH_nr#|Zz?0KEG@)f(kfTpx8Xid zuU6}2rD7td4^!9uKmBkiphV>kBDra1X4Koy1RKnw2S3WK&ujS2uMt<}zb|W>ib_Ci zpvo=*CepZzP>X}wv^2)-U{K^2gmgmo(k7aWzEU)#T{EreVHB@?`UMen2 z*+mXo7=OKYUeM`mf(tOqpJy+x4H|;P@j^@lWy5~OY^j4OK za%WYzI;yw*cK_-3zM@c)ZKi!1izQW+UYHdI#UEYDp;26+y4Ff+BT_GExVYZ)p$1$N zN~&vwf39I1<5ts7(9>6#2GAFToLQCT(EOd20p$d#bV5}uh_iy_FSV$+-J@)CamUt& zWmGi2UwFW`AT{7kA&-A zOn0<<>099cEu8u#Cr1#7n#cqAJrxj}uS__9&KI1ZT#X@%y1?JMX~<~8lD)AbcqQ%7 zg`|Ai>lJtK++$<8lW(&u{VmIGN7wGD>JuE`3D_3bx}WO|yZmEut-@RXD@R)V81?I| zLl@3=$=+JI4$I%6>jv$SejjE_Fn;MVrP+QR%e z^t5lDG4+5}Mv=Z1b@r1U<7{Q4uTp84YuV>ZaU(ZqktYDBQt5%YY894j?$vMmw_JTB z3&x1}r!LRY;QJz~AO{ko6&PaMJ;L;B19e4_l+Lf)J$){u4;FFIQXQtKiP5$lX5DQ( z!Ly5TzHziIP|!B*V(Cu3R&}OQSN9-~cD_YHMYN~P5C2AfEFd*m!;$&n!}rO}DF0Jn z0iS@p@EeigM4#b(l5ZK+k9O<&nkKX9YKVtqjcxhcI#}C0y;H+%Gv4Bw zLso@0<4QuFzNt^@nJk9AYk7mq+szP5Ic_q4tN&Ha%yXlbaDl0pG11{r^k0W{l;-L% z(6{Yy@@`}j$nO^WB$OCZJ6b zju>rO{yxt3MNOy$z80hO-xD0DvB1~0blv7*`4sonRNXn?;MXg-x2j|pTlFI7j|1xW=yD2}D`{Q>Vr_&7NzGW~AIr7s+m zc}Q~iC*Le#f`tjn-xv8XGn5-s5$8AcmSixj)3jsD+nWYyW|MtM(i5Sje^a}jjK4Hp z>rRRqaA)4=g^vXm7^w7i`75OBRaF&U|LDf^3JF^a%Q!lp~w9jTxeE^yRxjcTH0&b3Rx25-;*H7uDq~q*)=o>!1PTEb9bzZtxq{?lB z=nMw3Lo^s>W5;-R}~0{hC9l3C-rKM}vr&hFhCVPeK`dA(5GCn(l1 zXYN9Sv!4v&Ge8R0)ME+k-q$!alD2~uBj`h1HF?q&1AnyihI%Vt6*FR6li7`0E7SW` zxt!InCX5?UhTeWPYUv5G#%rm}G_Rs?#is?ADW2fHHOWaC)eVKiDNFKnuV={Dzdy+Y zKdt>|Gnb?3CYgYlG}HFMzITfC0%to;{VEB6pT>|FCR^TzeW-*;pF~aA2(|{@EGIxi z^hFURxVxt676pTdZ*>r9UnB)1G+k{Z(#9BOI=#FPvYDDBETi(EO7m(|_E6dJnEscK z8#jx4?*?y{529ZCrmrVgxCXV4v7|${Z$HU-5tZxPy=}|8wa=Q8e+~+HI{o}~WBXcV zg$xsl4C4+3e`DQLva>x3N$AjOYz?=2IjJdT#Iz={YZh{*dTF`{cAX082y52Vkt_Yf zvGd4{GQu6OY$LA6e$pIK__7-5I!lbQb7$jT*Rp_;@?V_u=O0sHqtPh;hZNcaBPzJ| zUE;tn)HSCPm2eSDpC#oFO|!IEiYWhSg>|Am=UrAoZ8+7O35E%u^gvAvB8FKF>MOF` za!~i`qcI=%{2Rgn>~nBz`zk7%o~wFshbi`J^T8R;?#A|$+;9N7r`e@F*291BHeK}z z;x~6yd549MN6ewZze8<*MpTqv{G|HhWfR__@Xzu88+$`4dp)@^Kz2SrP>IVFRP zKdF~?*vHWpO`}uZ4{nW)dd5JIkB<`Yp?e7y*J$#C|40nI>~Ht#J(p~scJl#Yv@f#1 zTb0X2?E5Y}t!MPft7;lzU+=e*W+>G?ByaC{WCnGxJ_7Uc7x6=&dWLYoVVJZYw|3b}_(*PF0SBYkMkQ9nNZrIH;_pn6de?)_>rma4n{02bQ9T zAOV3+!6^*`I z#qF8F-m zfZ4Xe+H@p4l^0%im46Rj9tFX5yAMemMI{XZrhHogRh0fm6eq# zfeVQs!W~6OUW*Zxt%fy=6@sQ!*BTyHUO5jA*!@uYJjtbD~Qj(n#-^Jsl&Lg zG`3$vaeFuHy|^tnz0Uah%T|842g?93?%iOTUlAdi^lDvrXM%o*y5TXDjX@dN+WyMTNDrb95&=J)GUy2c?$Z& z+73CM%Py0f%wU*?lpy$o8MiWQ1Ikv!U)AUvFsbhdV`vFaL8h2sh|;c@GJdH{$X- zdrwEt_yG7_2{SOPibB)eoK2u^*Ouz~KOm;eRhk-gmava8xH;tM=1vz*dt2La*+F_Q z8L3edzP`~rQs;s4H%qpSGP@bti*-B9%gWw$>Q|R%kVq@z!P@6DnIOptYGL1|s~W6& zJ09YQ#R}$&J&BipPXRj%FP)Ift63NeS(#dtKLkaKtBu0dkqN;8zp_T(A#ro&%y`WN z%q)%~_O;-IbWq1)_1v&O>XXbgSp6@moqg&j2c#0o&el<{u09L-(q{xoXGH3?6kQ0u zoUh-#-gzpD`?$I;0WOJQNmvgAZwv^bQ%uZS_oBGivY{Xel! zpEPQLJ%A}LBapV9;%@5Dc?8-V9{uc%)gedfk9^5GFlJp?X*J%6=uVkVa_<^n{~{@H z$yOjW*|rFQmlASGbg{KHlON6=EHY!dlsVC8J@8*gE;HTS%$hpxk*UFv1V1701@SdVh=Eei*G@S~ii&k$iG zpQ(4U)&Dfd(oFeCgxwMxFmS}zRZbWF02#lvHUg=WgeM`sUX=387%HK5Oa$1;{v+lCF2q)(WPLsm}QzESS6_@r4L9~y&e z1{#ce3B8FJs9at{VuE{iL%`ch)%IiP)+=qzg0Z&cC4eFp-7kEz~-=<&bQLQQdaMSEA*U`KA)P zv#fbYQD9Gge<98B-{5a9`NX;!D7WrAC9)HCAzuz4LsN3;1k#ik(9I@IS%wMka)dIs zz?RT7qF=>^^Ey|niR)|KP_Y(i*F*(8^&wSQ95ODnAXdWg5pvKG=tdiU>y?MJd}2A( z-tSGM6Q1Z*g(abSJtYjS$l&Q#iE4Us4@(+;)3?SGm8TvOIstsF$iqKM=Y=YGD=tC0 zRRZ3^dO+1|Gr#yMwr6?32tl`_L}W`RmuY1HM%6IM`&GrwOYlH4kXeb8j0dsD$MWWf zpptu_StOEsA!uJrdaZny?^7x`_XC0?h6y3B6bp*0mHbBWTONBEq#Wbcluv(H@?>3} zB2UD#r>8eSqwGRX1Z>aE*9*GDw7*V^`~{VaHLJ0K`)MN~CM-jd{eaGwt&h~zINH!! zB4&!_&k3{*-(D6b&|$E%{0%1dAC_Hn2!GTNenzeEpZ~d(pSJ9y?}TsqM@EArA-(i6 zRaK}Dc07iyKZN5~LVeJCNAm_P1bU2b3r;aK2~{qWHYbF#!Z1j`X36nLWBb>yF{vsR z6HnD#PC<#8&B;PH)lTNmxAYO~W-YI&qWpj3>y}4GE`82aelyHg&KDjm5fPCjB4+`Z zW|Az0iy2V-HlzkLuN0gVcL@fzCDM-nl-@s#nz$F+|IC3UgH>sszf(hKz%`%!)}pHy zvB1lv_s@4Mk-V|>aio=GdjH9#fq~sB-1>&!K3HCp{m|ha{wj8^m93xXyg1udFii>h^mkB>4x%8+dTr>Ote~tl&-8w(cZeN0McToU#YbU=9w?@Y%`*w5B38ZdB zd+RL>cD0GZgN>v}yn!WfYOOcF9Gz2Jj?qXoQO8Sr+`9Ya`ws@&&@Tzl2c zh7rE)T~^sa6$^mdvim1{V`hMkyn+m|IcP^<8lcNN-0hUNClxq1A<-Y$T9h?1T5mR7 zZKf_wm@{{e&2;y3X}V7kQ5`y4Hvx$TGgt}AbDhzlf5S^a2T0(*48(wxQx}oJa0@_q z77%h6UQ7mz;AUuRJfhNW#i$7j=I%55V*WP{0Abk35Y6dm4w?a9dxJ0^dsL(mCK6b$ z2gn4Rz!;PT3aAqJD_h&6d}7@gqF_N^j2S#ZIX)M%_4J)&(e~eK{LOE?;U0#8e>w1D z$gdJk;oaTb0uV-r7jrvL6S1FP#8N-C1T1)*nn6oUoN9!c=K0>J2{0JKkiop4Qdfy) z0DJbl68#nh90`1dJFw|=cTv07_v^40LYl!8;rb79BPGO56SyU)hknq6t^OXb9Dqb} zgr)#tH{vmahSZGpKpAxlXGWp1+*m5ki}?wmiH-HAvzEeu#G9b!1;BJ5x zMt=QvTrb@>ry{r>ApyNXX99ofa$O{bYEQHuyghe+-`6Jxl5B6*6y)atzqXfxI>e)2a~hchIIe89|R0FhTz zebz?dbQ&)O;kuxAJUqNjHW7nRVz-e6CDOiAzNdn^UGQu{;q7J`4dMKZUV#80ACE)( z=!9RdtvSdT663|>0qp~XR6K@b$sD@o*Cpy}Z!p<3XC>GQ{Qb{}cGZE68uPri9l(GE zA${0Qn&j$oiHcS5NcsEsWtyuIJp_kG*4VAJ_(AS&fKvnAakJxbFIa|$Av_zQyjRK7 z1p0+xsJwjINlS4ZSlll7l_KyBbfhH0U#%AaGj5fe-wjk(%PIc_A~nMoHt~aoI)pUP zUfqbNk|GE9&*z&&N5Po~yQ0F|rN(tXBPNUMPQ@%3Q8SJM zaDCv7qy{7ORw}XrnTQ+U zl90{4;0E{%cFBh|PdP8S;n(Op#5t-S0JjBA?A>qUTi@!#k&a1uPQ6Jw48)nS=5IcFbf1ALSVbP`<7{d!W#dDD!K@q=w*tyW7mCj|PwfQEFGm}I46IIoW_Wu# zgrpHN2rBk-t!+TRfIOLi#8R!!B-UaiD8izE5uDb9`D89JX5Ld(QWj7IbJI??)=3R#@D+ z6gUZ?TJ0s##I2{ztbSy-?|fgf^g2fiQe)4uEz3OWH8)Z!77Rm{z2si@f7$+>U03L zLU}ye`GYD-aWsh*!v3*pWS;Qln6@=m&kl}QzImoAa#)Om{_h|Eg*I5xB1U|bcs_Mj S0uJDc96e%2%=^>j(*FSZfh+O= literal 0 HcmV?d00001 diff --git a/docs/assets/pylyzer-logo.svg b/docs/assets/pylyzer-logo.svg new file mode 100644 index 0000000..1fcecb8 --- /dev/null +++ b/docs/assets/pylyzer-logo.svg @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + diff --git a/docs/editor.md b/docs/editor.md new file mode 100644 index 0000000..2be3a59 --- /dev/null +++ b/docs/editor.md @@ -0,0 +1,12 @@ +# Editor integrations + +## VSCode + +* Install [the extension](https://marketplace.visualstudio.com/items?itemName=pylyzer.pylyzer). + +## Neovim + +* [Setup mason](https://github.com/williamboman/mason.nvim). +* Type `:MasonInstall pylyzer` in Neovim. + +> If you use [LunarVim](https://www.lunarvim.org/), no setup is required. Just install pylyzer and you are good to go. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b11515d --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,50 @@ +site_name: pylyzer +theme: + name: material + logo: assets/pylyzer-logo.svg + favicon: assets/pylyzer-logo.png + features: + - navigation.instant + - navigation.tracking + - content.code.annotate + - toc.integrate + - toc.follow + - navigation.path + - navigation.top + - content.code.copy + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: indigo + toggle: + icon: material/weather-sunny + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: indigo + toggle: + icon: material/weather-night + name: Switch to light mode +repo_url: https://github.com/mtshiba/pylyzer +repo_name: pylyzer +site_author: Shunsuke Shibayama +site_url: https://mtshiba.github.io/pylyzer/ +markdown_extensions: + - toc: + permalink: "#" + - pymdownx.snippets: + - pymdownx.magiclink: + - attr_list: + - md_in_html: + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite: + - pymdownx.superfences: + - markdown.extensions.attr_list: + - pymdownx.keys: + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.highlight: + anchor_linenums: true +plugins: + - search \ No newline at end of file diff --git a/mkdocs_build.bat b/mkdocs_build.bat new file mode 100644 index 0000000..a3c6774 --- /dev/null +++ b/mkdocs_build.bat @@ -0,0 +1 @@ +copy README.md docs\index.md