From f279dbb574a185612d5b4fecfce3b3d72d26ec33 Mon Sep 17 00:00:00 2001 From: Marcin Kleszcz Date: Wed, 14 Jun 2023 16:40:02 +0200 Subject: [PATCH] doc: Improve documentation in index.rst and complete changelog Signed-off-by: Marcin Kleszcz --- .../images/npm_family_logo_primary.png | Bin 0 -> 16277 bytes doc/index.rst | 125 +++++++++++++++++- doc/links.txt | 14 +- doc/release_notes.rst | 28 ++-- 4 files changed, 145 insertions(+), 22 deletions(-) create mode 100644 doc/_static/images/npm_family_logo_primary.png diff --git a/doc/_static/images/npm_family_logo_primary.png b/doc/_static/images/npm_family_logo_primary.png new file mode 100644 index 0000000000000000000000000000000000000000..2e982d7478b76d97df417bcf910ba236ee21b516 GIT binary patch literal 16277 zcmcJ$c{r5c8$bS#GL{&mY#Fl0J6loGShI&HR5F&(W(x^}sRk`-C|gk~(L$D#>@tHv zBwN{QB4r=@*uUqD`h2hJcm4kT{?XOrnX}x>>wewm+~+(utu2kWa*A*w2(s1G#Lxyo zHc5bgoTx3}O_;I7e(;}gz+r~~TOW^rAeT$-h~60=S9b|hFBeaD8+Vs8!G87b+6bbf zX=`M1o-|5S34&6Ezf1M7rY$9k&Nrct$P4HE#-w0(pth|MwhS){&Nf_x0=^Zc@ z(-5xGdB76$G57M*0Ctq=Me}9zZ|@V6MmOyW{S-IXR`GuFdXq;Rkl^A#(~Fv;>+kS$ z_&)EMg>dx%1o_BA8z_qq^I8ttj7AXW9(ulaMN>GwYkqP)A_}~@a)#l+LrWi}P(zZ^ zBne;?5(g%0ZP;KPRUkf|qhpM)Ac(jCwtwq-Nq5Gq+223APtgX(b298Tdx<;HQVw^Dcd~#6L{d7ANNO?5^_H(iKAu6}UW~BULF7LR20cMVJYy` zW}tTi7v}VOz}sKAgJE;{)dO=E?5}M`khy5mAn+2@N>{i_DnOH$HgF}nvZCQv7z(Oq z1XLl7datEN{I>oluPAoU5Tz2%Gr#$I1`Bl9Xt=pEj9PI)PC( z51xd+spiFudVH7|3Q~ABI}*jO1ni`VF9W78d9I4q1*2Lr_KO_A6I-(i-}zZX(Wl7N z`+N}>kNz7sm^Se49q=oAN>l9%;Hyjy%%`EA^Y(60q)%A9Sb~-;#FXZM=nsYZEOCly;N?hCpt@7g4Cc7)UpEa3W3K_1 zLCAe9qfn0$=~MZ<7|-{29zm@;|HErP@Kx_faOzWmhzpJ+InRwOF5PBE!B)&C6Pi@K z)1z-%ccIm^#jtj(ZP6%NdiMqh#WC3a!`+VWGwlEV+C=6FUpsnY<7=D7_yis+&G% z{`C!!v=@Nl^9I!rhDs-f@+s7F7%aBgtBhA8<&M=(1o7v^Sncvzg2?w5^M^5s!c4sx z(wcyh`Ez4F5ovCTKrm==l@Ij%^FISM*IO&l&H4aSGNXN|Fj?iDB z6F`(Fh4d-u>q!D;xu3@q(jG8{6G~#*n{bOlRZFMyDJ3v_w+l1f5ksc-VDZ`G!XStU zS`=z&j8kji`q_=Ym&nE`Cm5*gkU5kc;L0cO=q+3*gSm}V*;9qzabZ7zYo`1=_zhAZ^ECZxhT1-z0vF9s*N0iEMS zlCSH!`k8nkX9mzKDB2i>DBCcHfV2?o!D+xa&&7}9Aq3qJV;S#mYi2! zDQ4IYK=cymewC0ZK2U32fNF%!zeH9ZZp5jai4x)jSp@!4M#lN)^ia z!SM2X@nVA8u{l7b`_SdO+4QOBPmE=29f-16NbB28!w2E^Y(4t}3J3J}jkZ=-gG$evu zdo#Nm3u)q_C|1AT#{LQe(gL|Z#tH(iCyEqk>vX-Ur$WOl_uf&6=T!0rzTX!^VI7i?3^Ru~Co}19h79oE_)&;1Kp>@N{hv4BdK}n6qM6=ew+)M(rw#Nv z9ckVT1n3pSmaGjwzxTndBP#~t`aqybL} z|D)hT$^^hMI!s`xb7G#(j`Tj>0VFa3E3c+M|0yy-YqAa7{Q#owxJ-aPJH#Pebv5?S zpUSYGgFzvI9~>)*csCz@s1Xb|h|$&$ngQ!APsaQPi5T*LOeo&h6tT@L_bYaDAOr{K zW3mC`YP#QE5R`y$I!u9Hx?llQZxQ|D9WN#=jDI8`uj^tAjJvqo5Y&s(?dGr%mgaU~ zhR&Cb=ZA~0OkNDFdYRHl0f8$Fp%!b*xS~1ZVjZ%N$)c@MBoG=E^P~(biZ%>viPJEn z3rMvvseqfJ4XuX8+LS;*t29Of91)8ChIZ%KmD3^b)wm(ax53=^9k@CK5Jot3CJLi~ zAEQKzHhb1VWVS_pGc(I&+=cS@{RL8fOHrG9`s^)?*hLM|bg*VT1r}N*Dc^rHsaJH1 zH)K)?yanwTMAIVa^IeB(Xzq!!`ccPHeyMP2+R8LpYr97V&2wdHtB6 zx6E7R-l|tJAs>Tb!GjQ5C=8jp2iSNA^H(~9?k9~OGXy_EMH>&{&#DwX8Z{ag429T5VJ?Dx zz_%Z_)7*e7$GkAuuTd<3iGKLe+&Xl^(AdlTX1OQ-jWzYzWXxitgA~PB5kGc#STOy- zMq+z;07k~mxXvz^v$!|8K{KE*y`JtUq5D_~MEB1BAT{=D7UW}3%Ex2~qJ1E~LE5W` zcT(j5@lK#uowkcYpbXz=111cirpg2-RYCBJ?h%^7^{Q1S4G1OQ0&do2{HXl~lz|#3 zQ>Zo!q2tSd+Z$9=WMKPOK!-oxSlJAFLzu77SX73+`Gzk3jI)uXmN#&#q{?0WL_iC% zw%IVf>T8(dG`Xu?nO%lHy|y>>1dnxx{;s7&@3bf|G0Tv|XN&eVy`Vb{3o5`EB9a!1 z!4i1uCLoXQ%;_M1nwyAOu89!{hS&>?FMW6sAFxQ#;C}vhXu$jLnbt;QvHvBKse>Cx z0W`-ny=>s?*;`_Nf%}{X#>4YH%XGgpLUmVx@)GV)2YI_Ff+LJ-6J}bdHnG?PR=yhC zgZf}r34FWxuwWPTL^b!{JZI!~2`&o2GVEg`$P6ug+KG0jw7}z-f{&?a_1Q4!pUeCM~3~j8h~~QeEjH} zRz)*6VEfK}|FgYx&a&|ZNC<>tBE(HF2zmK?AX0Q0@<6zgqFVqbKADHGmwqvO>lqZS za4SZHJM;aqki+$mqshhxESKq1T`JaZ;kIrYLRf~mxv)Ed9`|(vycz1iWW8VqyV}N1 zlj2e|fT7kd4kK7ezWkX82z){**|b-R zz*Vjqce^35nQvR4Hj(6(9(QMhE8fG9B^#qKqeek9sUS@zxI8fegX=Ot#~B+YvaL@s z_VZ)k&VpUVBbO(3;8*8<7zkxRkPtvwx(o?SmVNU#95=+BwK>Cq6Vt_+VgH*6t(P*) z{6;oT+yGYx*zg(cItA9x00FxH(b5I6Z|C8%i}H~PqY)mseRY+78`!6FlJYSXE-+}< z1F}PE#=s+C>F@d?zoqVBt0FY@Ejpj&`9RI)9!Rqfv^L0q$oq4N3W@>EQCAOK;zc3t zeAv50l4~j_rttxQ?n^mkgnz9?Sy_5ETupO_OxwOS7= z=yGfdz$h=hIQ* zI$!5?HSP7)mn&>uaaVLcgg32W7enLD_Kf0)mxlPT`t**zGBL2v@NHycAvS0i2kyFp zS4_q4v}|7spS@b$@gk1ZTc_~1zj*W7YA$~iFOip)E=CJI>n`*|bb+9fWbEroxyy_z z9(!-4&vLS%J5R_fFZs)V(%LJw5OUIG=2KUs(pwIUG1<6gQP{Y3?8w)ZgJ{oyR z$-aKlZmftqD|ncN0=799W)ogrZB<0;O5D`hT{acM-OTBLbg=U%nu*OM6VX%>ls0^0Z-Sg^wJ6<<_C)BM-#&s zsI)9g#>)Tn&ZZp;gpYgmIhtEl@V_%PO+IU0ynIiI6gIEAjvBDvXF`iHgvM(1=K{lyAYOVT-k^R_-E6P-*mn; zJ>=?eS>4?E2-oJQuBg=114qwPGm9_`3ziizEGr0*Od-u*JNrY3_m_LkJ;*ob8;l3! zyfFHo{r_xL%l_J7~oaancA0SFvQEaCve@tUuQ1M~@@IIoG~x^I$@4TGq?y0XxZczWkzQH@@aL z><~2~*N-jIgHdv;2jb6iNK{__I+-P1=|kDfX`jW1MRrAzCRyw9I2(8WTQ8lnY z3nd>iL`dA2@0(+Xdb0Hz1>WEGi2k)d`r&vI#jQcmh@3F<i|F&wh2!sX$duiV%G`%S;o2#P`=cFAO5Q`bAFUmg)n#vB zeJfZ^*zy>5wx_byF{ciF3Cl)^$9qrg@X~NCy3rzXiO5S}(9)9;wO)sn1A27EQTZK< zitX9FG8f_n^vS<}<5*1!oeamew(eU}&kKd=2f56P>0*y{`6^ZRfcJ=#Vh2$;u31>a zc3=(7k2UwPjkJF{r#G&0Q1zFp44dBE5(^i_~&pPHc&FIoHP$Lx~ESg;#)ig zqo*|w>2%8A;~9_GV!ar3dkEa1WbpK$K1!ilh3lTHsXNP{A6coUbHP3^Dq$yudQgf* z#fee3o3KqB>m7}5YHE-m435wFVmckD+rdy8fI`?mGH6mMh>az}dsnu=#kN)U zp00z9yz2M%aOQadyyck9BeE#W3AR|;Zci`!2Ww)ZBmcDtHRR>oG5qSpy+dw(tLpiM zE)9ID5C`EL*_eLnC*7~}c`^S^gHBU@ll~l$0{-HIqa=af2F|_njJLkK>bF-7cs%e3 zb46siF?tQcvA%h{fsFS~kMNn>vTh*y{p2Z^Z~U)6)AJ8A9JnxWAJ)z?c)~V9v+L_? z2i7_-f%&4BUG;?nU)L84RZD9w(+q!rOGj~<{| z_Xv0` D7nXj(nG|q*DJI*f`&M6*uWaR0K=nm2)3Ds`f4Ut!-4Z3}O0@!e$)~4`m zywWWWNG)Jfiq`!ZJpU!()V(~5X&#M~Bl1!QkGxx44!QpBrsZy{XjRE|Iv@5R27osJ z@W#yx=TOtCY~)Tk$&TJ9+VP?pyKA(T{Q`?!60&vp%M$af0#7Q-;mg$dk#m%2WEY{a zYgd&vKRVZh%xv!HZC;pbl!T52l?pKCXryHFYQ6t)xz{(%^Vf=o0bSiq zaFt2_uqu?jx*Mzw$vZ|bNU?w&Hd=RA8*xv{s&BG9+Ab(fcT0wY3og@PP!g=^!&7dd zFo1O=(&&6Ec3*TO@2AeuQTF$8m+q%!(THlj7Gmegl=?c?D}$YzgH_AITg?K0I*i_F zkVIAzoJ*UdRFC)>GZ zA@bf@{>b{&`on;}l!$;o{%MY{aV5E>_`6)K8iH@819>y-$?TxW;(~A#h_4G>qxQ@2 z(4OZ;C_N0&{M0{WuKM))_3L|RSch-gg_OyW^II@d8TN}&V85_QVx1o6hHxwdi&?g` zUnn{;j}uO1!z}GIQJZ-6Y3l2H(v)@LY$2@wm_Z!v=8|w3ay#&=qh`%BNH|r3Lt=_z zTtxcQT&+BSm!<5y7Jetg!7O*07gLh5X&V}QiA&;>(7x$a4RQkAJdJvS4V-To@1I(i znldlWURfjcRN~$zx|SacNpOb?VZ=R>l*(GST$iy`S)k&ZK_%}|vhjXZ4#4wDl&+?8 zV~R>OOP!T3{40-lMUv0~I)J#CT})Dbunm_ZHtuwXSyG^foUFfg@Yc$pyk~tztjMb!JIx9ugJvZ#~gO3g9mA&FPt}Bm#N4TIzj%~xB+Up9TJ{$%E*IB>xD?`TqE>)(u6 zot*$bu+XI5t3)Z7<;Oc^@WKdp4yQ>mn${xUto9_#_z|aHfUqcBr|L-goE$#>ka;qu z-0qgnqS6e-xlBGj;~w#|L}OceRBQp3NR)BF8FoK!%?i-(z`})DM#drI~?p{S<`o#KQhU)&H34FD_ z^d6j;sK*<;=hFzxoaL;u-ap*V4h~j_rad;J8SfWX2ds-N-=Xa%5 zYvo3^$!=To%*x$zsZE%b=62V|5pkIycg$O#pNqI=tRZ=3%my5R=w9x}pCr2VsY^-X z8^Lj6au#WIKwCThgu6n!;kxJZwD)SMx*jyQ7M)cWX(BHR+sJkgt*`pV!urMSRaI5z z)=9YwD@V<83B6?M5d%xuVz+-E{*>(@;@$W6zw9zFIk;E8_r0OsuwZPu@ANC$6JTfE zr+b#ENi;sz+T&M>Na?$?JQi%S6KI>5x;h>^purElJg^v~?jmPj$p&gKq?EwdOU}5#uHIf7lIlY08z@DEV zL^gdT69jcY2N-ecN?b#a(Q18YxYlQap(Dj{|NIyMp|uuXO6X;WoW=y3#6#bE^by>4h91i9S-x zQ&Pisw~9Y$+Z77?Ca-@LXZX;aKF?igsa(HoIT`Fd8PuH5x#PK0X82BjZ95r8s@+Vn z%-tS!2^w+Yy`-skpU$o2jB(z}S>PP|ib&x%Os^Iusggn+HC%Q?Ee>hpWj*m_R}K{{ ztb{}@U->4mu56&IW4W@rH_NR9963C0KF#p{AvwX~qLiO|=?!=AQW&-|_48Ny;q`W7 zmWfqw#)yO9cyd7J^R&Q_VK)+@AG4|dSwzV8-~#0+#S6~`JjzOhBPJ+2%1^izQLUre zJbbgYQtD&V_D#L!o47P0euNF}dP1f{K_#Dhg{8$o4DF3-~8;8 zl>Ghf#XT9Yn&rBa&a?dDzF`WENAtivh9Ta2*`?_BaO7!TQX*w@`gvs$Zt4&9Wg!+~ zv4c$S{QcT;i36zRr;m;@>S(vcZ>h!qN|g;4wo-T4dA{NPdi+9q`S`+Ax7nOs#HH;DtYMoatj&j6-MUMy%G53l)LY)`GDF5iNPzb zPRpKHVzxl3$mK$_vQ-h!i>2*P_b3&QrQbowjuj?rq4Wa9xAg3v(@~BUf1aK-c<{Lg ztec)E3ir@h9UGQgu=C5ay>g-~L}OnUZEq5(`J35&l$o! z+!MxJ%f7z`Vi5gyfhO+CFDAJSbMxxwCN>`zY6!GRD~b~CX^nVc`~6D)ZczJ{9IAIH z8o76BXPHd!jGrSd?7-=PT7MyRBJu5`_Hw;$n@UZ!qNx?vKa;GisFuMi9d-B0f)8ZL zpgpYJw!Y`2j>Ts<$TW9e=J@btmXn2e1}AcjZ-K*|#cMNdV4?QTZ!zZ)r&<%cGrBT*U!{0gBgqKFAn$N4irlJ*qJ$$I)dTPX;D@|wU~v84Xhgan!30-JU-^^kB~{Davo_45_)xxKY3$AZoWdfZa&42e~v1lniqqYj-TJUq82FMLI=Rhr*IK+wq)yuk4M;*OhBtmADeI`A_Jm z*%iWyzRAJf>&YVv>W)e$WOo~w6^nd#Uw_=kYh2D!{nmRitxWTmvT;a(w2x`in1 zTv78lDMGA+SHTv=(!J(Sapox!_?3S7PuF*G|FU{TqTRQml)I9xY0KFP!!Qgk|PGGS$3m#ZJweV{fA@<~(1&i#l?u&tZn=U)_tiP9x z-bJDTzgm2iJT!IZw~NIoj508=Fi+0=$1h8T58-GduG!6xL_FocSc}I`@5lZE9wV8< z<58167OK>TtUQ`!WMsUcEoP#mZTFb)ok7dcZ@vOiUL={+HjYoweW?`rfTznZeaJ z58E`RmmRx0PK?TOev^yZ{+dIQ7CP{DaNyWaC&L}9LM0ebQ+OA3?ng2^xrcqyIzq(X zT>y;kbqk=$C2~Z%Tr!L}a7?o;9~f7fJ^fS9=p9~l$$Xz{r@DRxM~G87Z&FOJ0g)fj zLI=HWQeRb5Gupz(u*+N$@Y|3lD>l}uyRk&uVx8CtOb;0 zVv(PNeJWWqJz8}nxJn)GP_4ZOcJ9lL87paF=U^c=@^t4r zYX7YL(8=!E*0Q*qp2yEF@z%xT&@Yb5%U>>f{S7IG8wob8UVWIi#!wQXwAVb8ZmVLyFry_B%$$o#m zWk(pJYTrV1?6lHhmA2zTt)dNhD-c};2k)A@?5jM+<@ydnv#vHz-?~v`(Ks!2t8I7f$OE2`^e@UzRR@pfM6DfOm-H*pgR zxhmq{+eDvVXzjhyKS5vIGIA*Mdxhj7{I|@asoqFFHuSVw`^#D-+pb@n7GsF3Y5(}b zxz~y@o;rKPV)Lr21dZyxe3|^|^{h!p_^xgAkrL77W=A1CL{c;BMo&q<``jJcN8!@^ z_>>k*Wkki^;hdbvtefL+z$wN3p)FSSLXtjS_q_v4^7y}NwG=8xtL+7P8DyGIu9=M~ zeljD9CtUy&M)W?+=fnZU2^i8*1?70QS0UlqV_}yTPW`-3o9o?DrX#V3zmnL= zp6N}>Ke><=H+qA8N{+&if7SI1 zMApboixjRQZ`wB z_`XNx-b~-BocE;)SNXGrP4i~Glj@s0YuiHYPW+rezx8hI9}`YVIruc&t-Zs-ve7;y z9N_g=mBP=$oM?fzu*&`9s@bqXzf0;%^W>!EIqv=!pm8Ib-=k1@cld1#mGOBq3-Rby z&9PdgV9|n@SGTntmBmMjnjY!-?YsV=pr`KMaPkcCw?b_4V2L`k*}BIaOwt+&%g9QX2Fm)zl~#lTUkUGKMHQ!^YWaDF?l;+R+lTDgEna#4*s&q!_3Li&ZUQI?Z95p@ zQrXolhsA5%%%>+-HseAR5?d8tt_vM^^+8i*+0bvdFN;TMkarlNByfrt>ci}ZYM;cw z36$HhyJSu$W~|tPQIvP}bAPK@yY^Ok^7GaFb~W~=0z-Z=oZnA*nO-$*23xGRSd+v3 zPL0;+`Va|b!t>B!bP{fbii%5=de6` z3iGOblOKmW&$sz~jq^eY1-W;Rpd`+CIcRANwU(Z~_CYu_#l^Hg((2pir}^NMA$>m|KTey0jEL0PtjY=Yib?e3~T**NB6Z3$1EFm+$#&6{9rv4YdfQyVgE6R zx+qI}(0!YBg`;D!34JW+3!dLEG)=uob$R#nym#W@IKFp&Ej#?~N^rTlp(cpQQ{;NqtwZz5!#XMQgR4OyF*0`{#jP(agT;KwSFIDyRDCwvqQf4yC zZ<*k9R9(g)!6a{XBJ~hZN*+glWuD)!Sk5}Z$7*uRCi~M`XS+x^8`|v0&>sfQB7S+Z zkGt>>CknUWtxy%XNuEw}9zOkWsQO-6dRWy9#@pi|o3)385`HoUI}PW;%~x)RIq!%e zC-m;MyQ6sAO^p3>6hGNP@}#XYVp7L#LW`1du{YAEXGt{H$k!~5ENn*D(DMR0Vmhka zrrN@GrY=@|7v6v>0RbUDK4}meepnH0&m4HX(H)oAFQ|K7(^cUsxIO?U(J`MK`VBItF|VXo0Z!rT;dON_DGrdLmM?78 zOJs}1*B%=d1UuoFs@BpIp)HeXQWTZPhs^T3pB78P{x1?F>mJsy)PnBo0p&F~AiJj# z4^(xp(p(6*gm76+iC_2O4?vFKC4VY0F7ZTcoR>yQ;QH)5U&O}X`|}022_Nq1#ete4 zY*wqLG!JlV4IMyQTvQo$A0J5>*xQkJhV%v;@JLFciP_8f ztM-gko+eHfV6nLDT|Sc+BJ}Ouhpi*XC3nU2A9F8T1%KHq`COe7u@;wcSiF7O$!5m% zwC43yb|iM6x`eR#yIJq|_M;TRnQ)7qHB6dO??oU^m(OyqoJeQYd50Tk?&dTGTm!od z<;QhBrO8z`nY2%1frDOAC(tZxoi+6_-DE@W#rCh})nY&9>ctvDCL!@jg_a;hdT z85SX2QEvs8`>&23un6Q;*Tx83ESZbj0`z>lEz#TSr&Vc?y2#IMlYs}u>=B^D*mH*i z=QLQ(6iKdVO?&tx4sHfb>nz6vI!Nk8i`vm2-A$bUm{i$R+s z>ql*QfVT(F2nL6K^B+6fQu$kXwQX5=3(`uavLGx2pb& z8l$pnO@Cg^tAp3%b?K8J8Cc)i>#4xn*|5>{d=^{J7+!Bzh~xp z*$>g0{=6Y+11!Z>=k2{P21q#u-#AMA6WjmATkp0C2dS-GpI{(!ulYyLx!YuZn?-T+Vwyd0_2T ziaFy7xK-BW#186@CNIV@&EQDz9XK((a};@U-Us{N_SH5VIKBeKH*kdwlr1}S9)n|@ zVKBmz%a74mU|3jC-_{y%*CS5WN)fI;dUdfMCIvj_YLqUL2bsI9U9 zAIADIUcQ3QfFP6*vzEV;=R9MM5(KLG>kPV62AWm%*b z++_pb9~c8UB6$fIa1%^|Ne}+AfkvYAuD&yx?B4 zuBDk1DB(hL$k%)sUx}o%SZe~M2hmvaz0%RlMre9xE}&GMo*W+5PgRPqF?%0`y&LHH zf6~^#O$4B6vKF*Dg#&+XD?5 ze5XJ?o(m$v0$km9w*S{oZ3519#u6X{e5?S>uLF9Of=j?33;(GM3ieHbSK%80!GwL$nv$ZNPNbesaFLb|b zk|{K!^A;cp3KM-~3C{V^0*v@X01NSz+zW!Q(6k2zL$WaFIkOe>iU}okU~K2dG%2Ox z9uNiqW7S_YhMBHX&t&6r_TUeKP+$Xz)!7JsmvMUEIlFQII)FeG^?%Yr?s&MD>6kTe zA^)Q`nd)*s6N>pU2q@lY0N@LRS1C4RwwZX&#`R=^9`}sdLK(Q_r6&G4)AyiNyhhLro*_ZAC7)y5=!4HcT7a7EFaB!gI0%(RPJ!#()>e%D7k@Hs+j&zMO$Z72 zi=o?{u%9#h(xZVFlh0Idtce??+eMSIgO-B`muJdm1Ssu^HQ>xdc+-{n!z+q$40Dcj zI7j9`CxSLk8f}-Md6HxJl?ZQv(&}DtG=eEmN&XX1{~sc4|0@PZ-RMZrOpQ#9XU_Bt z+(M3xV4%z=9s@#PT7I7N0!X|M*futwgXtdd8ovXZ$wWgeoCW_cE>d1X>*-zsI)Rht z=q3hp(6=CFC3M`FP6K{tbg^x`26P23U#K!ki2yII)=A-GnAQZA{gKq|QO4A;3tWPW z?W|+=0k{em#?~_79D4|0=G?!jMe~_cs{%JX=KxdhXSTluE^$lTQDqtzh~4YMWCi3f z7!nP>Y*>0xxdB$d9xnBLXp#AI`{nV7^-Ena7k!wgbw~jq80SiQ z{)Wd-fa{HUFunnjoG+bXqT&hYn0JBUu$MFm;S6NT^JjE2!vgsLWbf>EV-8B+1X9eY zPG&R!%KPX9&MOz~Lgv1_28XZ6$~EA1>L{=s@TcrT9n(+RxbEvW*y`eQF(t;J$y zd!W)E+CUCda0|d_DxQEhprV5lOlQNyK{yZvCS7K>F$6$LPXDKk4l`FsfXoEGAft{m zTSx@mO5xR4er^$1W?2O2bzViMX+o^1nens9HNe_U~Pz) N9=0^h(RaS~e*me|#nJ!( literal 0 HcmV?d00001 diff --git a/doc/index.rst b/doc/index.rst index b3d55886..0d25e415 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,17 +1,130 @@ .. _index: -Welcome to `npmx-zephyr`! -######################### +.. image:: _static/images/npm_family_logo_primary.png + :align: center + :width: 200 -:ref:`npmx-zephyr ` is a repository showcasing the integration of `npmx library`_ into an RTOS environment, using `Zephyr`_ RTOS as an example. +npmx-zephyr +########### -If you want to see how samples work in Zephyr, see `Samples and Demos`_ section. +Overview +******** + +:ref:`npmx-zephyr ` provides an example of `npmx library`_ integration with the `Zephyr`_ RTOS environment. +This can be used as a starting point for an integration with other RTOS or bare-metal environments. + +For the user's convenience, this repository includes also a variety of sample applications demonstrating how to use the `npmx drivers`_. +Their code is available on the GitHub `npmx-zephyr repository`_. + +Supported devices +***************** + +- nPM1300 Engineering B + +Supported drivers +***************** + +The following matrix provides a comparative overview of which drivers are supported by specific Nordic nPMs. + + ======================= ===== ====== ========= ======= ====== ====== ===== ===== ====== ======= ======== + Driver ADC BUCK CHARGER EVENT GPIO LDSW LED POF SHIP TIMER VBUSIN + ======================= ===== ====== ========= ======= ====== ====== ===== ===== ====== ======= ======== + nPM1300 Engineering B ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ + ======================= ===== ====== ========= ======= ====== ====== ===== ===== ====== ======= ======== + +For more information about the features of a specific peripheral, refer to the official documentation of the specific nPM device. + +How to use +********** + +Repository initialization +========================= + +The recommended way to clone the repositories is by using the ``west`` tool. +Information about the installation, available commands, configuration and more can be found in the `Zephyr's west`_ tool documentation. + +To initalize the npmx-zephyr repository, run the following commands: + +.. code:: bash + + mkdir + cd + west init -m https://github.com/NordicSemiconductor/npmx-zephyr + cd npmx-zephyr + west update + +Alternatively, you can clone repositories by using git only. +In this case pay special attention to revisions - both Zephyr and npmx revisions should match the ones specified in the ``west.yml``. +Moreover, the ``npmx`` folder should be placed in the ``zephyr/modules`` subdirectory. + +Building and running sample application +======================================= + +To run one of the :doc:`sample applications `, do the following: + +* Configure the setup based on the relevant sample documentation. +* Build and flash the application to the target device by using the following commands: + + .. code:: bash + + cd /samples/ + west build -b + west flash + +For instance, if you want to run the LED sample for nPM1300 Engineering B used with nRF52840DK, you must configure the setup as specified in the :doc:`LED sample <../samples/led/README>` description. +After that, run the following commands: + +.. code:: bash + + cd npmx-zephyr/samples/led + west build -b nrf52840dk_nrf52840 + west flash + +As a result, you should see LEDs blinking on the board. + +.. note:: + Make sure that the ``ZEPHYR_BASE`` variable is set as a path to your Zephyr folder (the one you have cloned with west). + + If not, set this variable manually with the following command: + + .. code:: bash + + export ZEPHYR_BASE= + +Generating documentation +======================== + +All files that are required to compile the Sphinx-based documentation for the ``npmx-zephyr`` repository are located under the ``doc`` folder. + +Requirements +------------ + +Install Python 3 and its dependencies with the following command: + +.. code:: bash + + pip install -r scripts/requirements.txt + +Build +----- + +You can build the documentation in two ways: + +* Use the provided script ``doc/sphinx_build_local.sh`` and open the ``doc/build/html/index.html`` file to see the output. +* Build it manually by going to the ``doc`` directory and running the following command: + + .. code:: bash + + sphinx-build -M html . build .. toctree:: - :maxdepth: 1 - :glob: + :maxdepth: 2 :caption: Contents: samples + +.. toctree:: + :maxdepth: 1 + additional_resources release_notes diff --git a/doc/links.txt b/doc/links.txt index 03f82870..d59ade51 100644 --- a/doc/links.txt +++ b/doc/links.txt @@ -1,11 +1,13 @@ -.. _`Application Debugging`: https://docs.zephyrproject.org/latest/develop/application/index.html#application-debugging .. _`Application Configuration`: https://docs.zephyrproject.org/latest/develop/application/index.html#application-configuration -.. _`How to connect with PuTTY`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/getting_started/testing.html#how-to-connect-with-putty +.. _`Application Debugging`: https://docs.zephyrproject.org/latest/develop/application/index.html#application-debugging .. _`Building an Application`: https://docs.zephyrproject.org/latest/develop/application/index.html#building-an-application -.. _`Zephyr Getting Started Guide`: https://docs.zephyrproject.org/latest/develop/getting_started/index.html -.. _`npmx library`: https://github.com/NordicSemiconductor/npmx -.. _`Nordic Semiconductor - nPM1300`: https://www.nordicsemi.com/Products/nPM1300 +.. _`How to connect with PuTTY`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/getting_started/testing.html#how-to-connect-with-putty .. _`Nordic Semiconductor - Power Management ICs`: https://www.nordicsemi.com/Products/Power-Management +.. _`Nordic Semiconductor - nPM1300`: https://www.nordicsemi.com/Products/nPM1300 .. _`Samples and Demos`: https://docs.zephyrproject.org/latest/samples/index.html -.. _`npmx-zephyr repository`: https://github.com/NordicSemiconductor/npmx-zephyr +.. _`Zephyr Getting Started Guide`: https://docs.zephyrproject.org/latest/develop/getting_started/index.html .. _`Zephyr`: https://zephyrproject.org/ +.. _`npmx drivers`: https://github.com/NordicSemiconductor/npmx/tree/main/drivers +.. _`npmx library`: https://github.com/NordicSemiconductor/npmx +.. _`npmx-zephyr repository`: https://github.com/NordicSemiconductor/npmx-zephyr +.. _`Zephyr's west`: https://docs.zephyrproject.org/latest/develop/west/index.html diff --git a/doc/release_notes.rst b/doc/release_notes.rst index b87ce2f9..82f2ace4 100644 --- a/doc/release_notes.rst +++ b/doc/release_notes.rst @@ -3,19 +3,27 @@ Release notes ############# -See the release notes for the information about specific npmx zephyr support releases. +See the release notes for the information about specific npmx-zephyr releases. -[vx.y.x] - dd/mm/yyyy +[0.6.0] - 22/06/2023 --------------------- Added ~~~~~ - -Changed -~~~~~~~ - - -Fixed -~~~~~ - +- Added basic repository structure. +- Added README.md file. +- Added samples: + - BUCK + - CHARGER and Events + - LDO + - LED + - POF + - Shell + - Simple + - Timer + - Wake-up Timer + - Timer Watchdog + - VBUSIN +- Added all of the required files to build the documentation. +- Added pre-commit hooks.