From b6c612c251d9f7294fd46a8a8b109a7b6195edb2 Mon Sep 17 00:00:00 2001 From: Hammad Nasir Date: Fri, 25 Nov 2022 22:45:04 +0500 Subject: [PATCH] docs: added sphinx documentation --- .DS_Store | Bin 6148 -> 0 bytes .gitignore | 3 ++ ...nim_data_structures-0.1.0-py3-none-any.whl | Bin 2845 -> 0 bytes dist/manim_data_structures-0.1.0.tar.gz | Bin 2254 -> 0 bytes ...nim_data_structures-0.1.1-py3-none-any.whl | Bin 4419 -> 0 bytes dist/manim_data_structures-0.1.1.tar.gz | Bin 3809 -> 0 bytes docs/Makefile | 20 ++++++++ docs/make.bat | 35 ++++++++++++++ docs/source/_templates/autosummary/class.rst | 32 +++++++++++++ docs/source/conf.py | 43 ++++++++++++++++++ docs/source/guides/index.rst | 4 ++ docs/source/index.rst | 43 ++++++++++++++++++ docs/source/reference/arrays.rst | 10 ++++ docs/source/reference/index.rst | 12 +++++ src/manim_data_structures/array.py | 2 + 15 files changed, 204 insertions(+) delete mode 100644 .DS_Store create mode 100644 .gitignore delete mode 100644 dist/manim_data_structures-0.1.0-py3-none-any.whl delete mode 100644 dist/manim_data_structures-0.1.0.tar.gz delete mode 100644 dist/manim_data_structures-0.1.1-py3-none-any.whl delete mode 100644 dist/manim_data_structures-0.1.1.tar.gz create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/_templates/autosummary/class.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/guides/index.rst create mode 100644 docs/source/index.rst create mode 100644 docs/source/reference/arrays.rst create mode 100644 docs/source/reference/index.rst diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index dc1aad70263ab61d9bc557c8960c624d1a9dc28c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKO>fgc5S>k2>NEo7P^4avEcIH2&_X4|#f0?0flFP%p`Z}Q7MQx;$aWf4Q6!(~ zkLi_P!hhieZ+5p*?3OD+)s8g#_G8}K^K9>WiAW6R(KDhR5xH+YyH{GuLDflWEK{+Ys#c-0Ja_dCOG`y)#!uLtM z827f{$gG?sS)40E62%Dl_#w$6xfsfM78Qyc=mEFmcE-J(<#PXUu;(4T7_9cZ<;#84 zpC25qRvq{8?$cMt1liFM>QvW%dO<9K8XJV}7bs)YWKl z#QJkxi@Ya_tYy?t1*uyz3Yd4w?OH{w0#*U5KtlmuA3QjtZ?Mv+mJSr^2mo}@tqgVb z>kss}1Lzy9G@=J4G!>|+!W=P#IXMVT$GC6eD~*~?LR}g2m@5l&LJ{WRAv_gM!q;d^ ztAJIYu0UHid%XW2{r&u3C)t)&z$$RB6cElR7!8q<*;{WV$9t^@{|sm2xJsj3u}LLlBXKn9D&`QQjxEYvSFHA4m=4e9S2NX@`ho1>J; z@`LiIchd%vJp<-sgcQW!7P`Anx?2WfLY|&Z$uRDFN+WsRVk3}FzhSOq?&e%>`A2aL z`ax$J)K590vj`9M=>Q=92mlktRVwBBS%IGO zcO%oXXEmn8)>;m_!IF!3BagYfoWkp}^yIlyw%68l@Xf{j4r1K$tmFy+oveckIbWR6b62mr3sLRVeY>&b-wYD2 zad-H1xL<^>GA;f08V&KHVG6E}cW{Mu`D+T@0#X^WGR~ovY(g3<;CX`+5K)|CH4Xz2 z`R9|hyVl!XLuAh$_bnoiBt&5J55uF|bdU`hoR^l73(uozW`i7YfxS2b0L$?{^77@xNh&O&j=xO4($HhG^!AIJ5C8MMxD>ZKTqus$KE=loD4) zDEfJ|y{7Z4GM4rO4CweH=W_}`0XvCHYATURi_Hq$&^|n(Szpk)c<945_Lb^$>4WGv zdPjv%3f-f*%d`z#Cr?3Pv^pnGxK+_S7^sMrw#l%;d~9SeJzSFP+iwNlQ6BTJZCR1U z-h;b%M8t}?#4WB170p??$0^@>m{HNIHEub#CW^{$fT`Y<>45J*@1Ju;A>k9F#XUVe z<%f*>1>kI-hmQ*n6ONh523@gqb@))i+v(=ayk(=)p73 zrK*zaSj1W8{hsA*Oh*@vn8z%dyds6bUUoH)e+AFg$Pueja&TJhHN~{xwylE|6?Z@( z*(!P{F9p#194%0+^c~)6>kd`+E3eQ}FlOv^?45`HI3SI5!0|vhU#|2AwSjXYOSUc( zF|2C3V)jvBI;AsLyzKZjp;vrHDD!W7F_>dr{sLS5+1Coz(V9#tC0>v0YBp-PQ^$p3 zMR{vK^_VoPdG17u>n2*pa2Okp>BR-f4=w$HsXZ&mv^2*vNb3^GXXOq*+Q1FE{jvWB zv1@CXc|~97hp69$4`Uw`cw<5*|%okzf}~m_i~Aa$64kya`Z(T z^>ikT$%|}=8e9@H5=?K=Y@7k>C5D2zua(t@ovsteAGK;SqOkk~Aw6h-+EEEAeAK9; z^eYHS%R=R#vQQUX06`k(l>O;VXV*Pw^K7;@$A%u|HkL>I18B3R2m@+QcY96@1@}VX@H;2BXl>4&8eoA)REk`IYv)M$M9f}8Z%Lrm4U2Q zMxhtp^=cy4B`5WptD`ev&x0uQ^V^eAv@*Wco8=)RiqdHumU}FXc_tbFn4}JL-|3J#Xib^R2Or*+O2Y)0YQgAFJgvgBf^6Z!KPPi||z^gD}%I|AdwKI;>(xw_-6MiqD^(|=> zmf=RUP*Ir!kKOkY2;QnMFP7osWC({uFJfI6gsqxrBz!&}&n}iBUuPUaPzsoP-+G^> zF{@OWwh5Y6PBbaO?~>MTlvj=ol}0#CXd5idqVVioHrc=t>!x_JTRq&Sb)flu&1RK- zSWdTnwcBdQE9=O1@QJRh&apE*b#3Sid^bZ$DhzqINo~J(7oHcCIuYhQ9gZ@H1pU0z z6})-1JawOkK>#4N@12_JXd9ct(nyU#v9bU_p77PAt4z{nOra4J_Xr&l730XY1ZT!E z?R+s>C-^NfE=Zf`7$jwBWU>s;-Eb9CkIh8GG|GpY{$O!2>pu`aWLr5moMGfuUx7#1mWYj8D8 zdVQS0f7swC$a3;X*u5;^QF+G$a>ABXKk#O;nW!bZrvaqZ{8@6#LZQOUL&nJ2n!qO& z#$tTQhx(D7q^fWmIZ2Pr$rs9nPR)g)EWmb`(COO8j`@O*{GPopRLo?l7m;k%%-XR<@`o(@=zZywWob5j=?GsEuix_1OZ$gq-v_I_xV z8PR`$>3o67r}c|%vo&F8K_O^BT(rNgKGZ+({VIw1>+$ae zrQAP#W{=kYfapJ3GzaN_5$*qCX|Km#-u&=L*|*1c`s@|ni;5q@;tcx@{|`9!YVSQV fKeQtl_pAN)0YV|@sc8U!fqJu158&2ceHi!?HROqD diff --git a/dist/manim_data_structures-0.1.0.tar.gz b/dist/manim_data_structures-0.1.0.tar.gz deleted file mode 100644 index e1c3c39df3ceef2f616f7528edfaeeb69f122c94..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2254 zcmV;<2r>5`iwFn+00002|7~GzX>DI*VRT_%b98cbV{~9OY!^?|;qX)&4b+p7a&p?&dzy66!2dtErf0i`Wk#kEMkJm`F~MQC zr>IKr`0DJ{oA+mmYki0FKkWDG&p&)u`?@|Fsv|&z^WWE1{Q&iv^Z($WJc;<oPWO!7<@qX{}>UeTpq(apW$P`bq=w0)0aFb_GDEF8{>9YpEq zEA*aHBHIld>|!r6+04Qxh%!SwGc%4>J_&(rdU$TSu4$nUW@r=iV#S`k)6<`pu4y~U z+;?9d&LjdUDiLo}m>f!hIsarXF=O+^_U2A(VL*INrXR4Sajz;!Juq{cmvu2L&_pufle!~8TuYPn1NlEAaLTP?S)EW zfb0<%)>x$8R!wYd>c6J`duH`tPe17^>S!>~M|xBLJ@fhxa^$ga{@5^V&yEa33D)1? z{;z7A`cKv9xTfha)YN~E0EUqkb%p_@fXp^tmLygtDJCK2nig|DiO`WG8HVXN3~?&I ze?=$Hk}^;3pmacYd_D3g!<^@2L|LgKUOAPxZ|DE|?)rY-7 zmjCt9h~|HFq^nK-e+*!W-pzirN%Q>NF~blQGJNazx5STw_E2*u&)6h5L4(5K%La#nJog=+$Yb>S-N!TIb*DJFu%X&0V7w7w_<=dM zqcz~DrRmVNu;E~D8LjB-X7Z~@&|A}qYvqjaT?8y-xg(bUU*{LsXQjE%*j}zE)$3p1 zz1hCD?OFKlTh|s_#`hv4wEx0@pljUf-2TM@oNLVOUL4#ju34>V zuY>4+vo?I})`~GMdQfin?G7SThVzQ{R_blae7pqN6>YFve8#FRmEFzwE^(-Xj*dQk zW`~`NNO6EktF3HS+Tc_@<41G>IJW6P07c9ujXpj=T(oXhyx8QyXl#tB66njZhD56)2Ei* zaOS+Jw5bXN5Sa3FLw;+!?lVk_>IOu!Zkh4K<#68n>#RfUWq|Og( zY>*!C?KWUYd)T1FY^NX4dNwn{{ajf|NyWVG;ndq1-N(IiPJCT1D#+)iGcRmho=@01*=#)%T}S>rZL!)h=s=*vHfQ8PnuPh!NP zfhuEp)k!-$ZUKRcE_4e1INw%`yt~>dr!~r`klPt@AxP9`dR8OTc=iJI5J;XpycBtP zQ5j;|5Zlh~=9sm*wB!p$>BkZB7wE>1JuCb{=Bn|0Tc>Ohad_Dy3RQDL&QqzBJLNh> zXuV2;C|IvPZa$v%YD4e0*(OoA*0Zv_%%z-i-h4dOx9U_|Qm}pH3Z18}0biKa>_qjD zKW%MTX;`Prwwmk->XL}dEA!w*SspO63Q2s4D&!NP4Ex`p#rA-rqkJKS;qA3LP27S@ z>`uBA>8ZZ|0a=5+-|~EW|8KwY{vaIuq?ZsNBA+b(vj=gl>2GSFfd(3A cpn(P&XrO@x8fc(_1`ZDX2GF5(Rsc`{0D1I%L;wH) diff --git a/dist/manim_data_structures-0.1.1-py3-none-any.whl b/dist/manim_data_structures-0.1.1-py3-none-any.whl deleted file mode 100644 index 153dcd4c295ca782bc319885790302d7caadbb1a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4419 zcma)AXH-*J*A5-&oeYQ+0Uf1`yv)4oo%wWT*5^HIuY1mq`|Ri3yU(-tzJ^c|QWgLJKzU}ofGt{&b?vj6 z@gFMyz}4Cf>58zkMq49LXiqO&w3p`{lsE!`bVH&M2(X85T#`6c41^mTj!S}9nHb98 zuZ~`Ytt{$@^bechp`sw2r?9?3u|9E-5q@zoHpyV{HIYcX>7Ey62 z$wqC741eGed>>t_O$q=+umb=W&ba(D4{J|PYu_^xLvUC3X=#S<8;EurZc*O{csoL- z6{xDvoU>3ZN_t8e7}<6c_Ee8eDpn_z?PT*2r1|_De<`5}_>3XOyVrjs(VPCNCOrW& zaE#ee)A&uRqT2>O-=x`k+7E1L73vE~Q{4X|P^`!LKrDIx5x<&tN~W9vNV7uziS~Uj z=k@1-2`Nk0=PrF~rL|X&DFOy^*u9(c)S~Xsa3CCi`=;U9GR|J}N{C5sF#;ND>XZ4! zpBH5#I^nC65}GCxFjq+zS74F&e(~Y<;p^92?1C8s*y+<&OAAX2pffilsKy> zx!K$D@zRF#-aW0z48^i9N$Qlx0aW)W4xGzbP{danG4u&RXlI&1DaL4MDw}Nq$;B_VOk?0j zj5)s^qt?6Ib;n1-@q&91ej+jeuFb3&+^M10l*E*~t+(+em?VNXnOMz|zf*a0iM!qD zW7!jY9p>EpNn^Eo`9>v?ilK6&Q2Eh z_xC?xG{A9b(tRDjz&DQOxFK;b-|UXnY6-B%-j>ovf_%I0u4}i|Xmp?#Ax6c!t<;t$ zA~8C|+NF-}rt&n!g7u^GUgd7L=!I61YV^XJBTP#l!Ky8t-TKg`*j#st^r0Nv_QT-O zYi~p=Vj8H0sMkG4GWHgOb0$neHjQS6eAM6dwoD)KE@LlaDq_=+s$JM(65h@O+Oo1r zVxJUwh@p!l@uxIZ;!v?lVAaiTMf&_1n5a4xq7YG8dlv~v7&>Qt&Yv?~Y*lGEjDPF4 z-E0VrlGY{5AYM}GYxyn~=T*S@ZWDy{j{|TxNAF#(16)c$_AX3?GPcB}&H}rKWsRHW z2^9d=f9^MGQF1;B7Sf6`3t=!Yn1Y1gyE?Yj0k3!DrrcU)8zr#||`9m`@c&=p4gq6+|L?MnCY6eOeCo8>H=Lg*=8^M#$NRs$KW5XZ0631`@J7O z@_J!}X-*#-z9Zo|*m!VKXkfErOqC74j=rEk3>j3+uA)Eqpn0*Zh<LRdjdMSm-M+4TUB0u;Dto_^0F3`Hu@v@+5@Pl)J5`8Q;niv2OJ5xc4Uv{pmt)`)WLj&w; zXJHI=pO&C$S%WjkVKF1LN*j;6bi@Y5`*do~v)+o4k~Oswras)%l1ILzqqK@%+T*(c zp>1?t2a4K?1PA5Lyhz%@D|dX^TXEoqT_vA1#~U2U$PU$xm3XB6aIT)MdkX-io5_|(_w z@9%NR8_u(zr!2wWOsacbnOXJ#$3<{nF%&yHnbd)296N$xj?MI=7~}A13@fPCWoBq~ z638J3b=w)O7+dLOR0O2{bQY3#=ugHNc;S&CoeDoomk>Xh_u*T1O-3HOwP zupJJe!s*{JZg(y+&Fe_lCS%KE!$;&9jfVK6MYrFQ*v7hUEXi@cU)chilRsN1 zZ=?|g&GSSA{m4$N`|{2d2>`Hp4gdiEGCMsDn2NdzOeNoB+UrGMNS(F4tuTYDFmsB(qL&) z=^%5Yax~1_iI*ocFYGZcQ`MKxC%ZAQGm_vl9z#}%hoS4%44~L08{$&Z2-^mpl$dt} ze0&v)_K>mih0_K+`H+*vTXzAqS17D1oaQvDxQ*-G+}`bBdHt9)QEL|Db5aClS4{vB zDn(p}hFs85M&g9+^V%leo@V^6X8fKedhdP1^!iQ0E=58b%3G z_zKfgyzAomFSo6SW$P=5U#gBcMDT1&EgLl6;TnA=^)?Xw){#u;jc2>3A@m`SDpiMP zjJSCuqdS^Qi0*!&`bg|hZ7KTx2>|C=2Fc+_^%@848ZVq2MD`b;BWuZD ze~9_EwPnTn)J*NWtz&H_V?Py`g~?2Y6(#(M9M$hhrKl2-wVIV30xS(xM|>M~Z0bns z)*&4R4H-H|CY+4789ZO~W@_K}1oZaJ^2DGytxU~=m`C#J27~==h?Fmn6)my4L*Gc2 zv40KIHPO_jQ>U!c|*Mf)|W z^oN|EPZ#kUreh_Qx2x5$86R}QxNjG?hA}yMnXNyj!@@-zCzxsmj;NQu z%_K>v^>Bad>Z6B*@7&TRb@hFsZjx0c>3SkraN+b#-9r9m0l!#6#k|hS#wv~cyiD@M zr5ab+jNY#YN*hD^_PVQpwS2_|NN0+2*!{F2zM}+?zx2Kt;s#-aoipArx0ySEIXp>BC-PRQRP)gt1#zZB@v;%`TBJ)8d0jxMFnB;NyOC{3#>bs=4< z7fu3!+i7u~=Z*uEPQ>!wc|2jhQ28ute~UCBrCU-L*Ys6xr;srZJ6jF(WUz90lyPEkD~iZtnnb;BJ&{>k3T@ z2Jge5fR_B4_ueW^wu?KS>kapz${h9KNpEE?tJ3HJ#g8JPmmo^wNCW@`o+V<@Uls{t z4K)K}^#q)fcdi5=VnL}jLYC5&m!6Aq?s8#PR*uhzQM<6=#p_Hg2NN=J{#Wd_8jp@< z6009yWKB<_d|hg+e=Pcd5@~kvoH?xyvy_zd76tK$W9PWIP5nxsRjfJ&$E0GCOvQ?z}G$d#|OsWt-a2L;Ya#pXf=AKN9ZMtV;Kvqf&ECsR)z zX0j*l7=0#5CUCrBkGt3loqJ^hpUvWG40v$TY>K3eI7)f@JtwVxFTE+UD(S;&o_?6e7A5 zCMyH0+@sxnq_O0W^p~a4Yc!n*BHM1xy7BJ5ut5LED!W0RPcyxTCbQNQvIkKf%TDh) zuNgv#h*?Pfy@fsdY=2xOA-~`Lxsm)o4eifxKX;=41p@#|LZbf_?tgvhPgs8|DF4JF zq9ywmYX5I}`IC>o)s27p2#Nh=AAePmKcW9Er~ipgqi?$;f|yn&ND@oM}Qk-S4aa0L;y5mH+?% diff --git a/dist/manim_data_structures-0.1.1.tar.gz b/dist/manim_data_structures-0.1.1.tar.gz deleted file mode 100644 index 79bdb5b083babd5167c5fbe3d98e8c149d881929..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3809 zcmV<74j%CziwFn+00002|7~GzX>DI*VRT_%b98cbV{~tBm?pbNFUip zt;rB9owr`+SUQL&;>oWA_2U&*HS8RHmr`OS>3^wIu57=PdZ{E!@)7!Y^bBR`da48L zkABP|pQ44QFYvikt2N})N~0l*jdES8H)_IBTK@HAp_=+a(Ns@WT+dlfyrqNPVo8)l z>7?7aX!k~KaiM+v{I69iN%LPWRjWr*rChGpDzaRXVE$L29HCM=|G#^=?u=1apJ3C) zf^cEkD@UKrJ(Qc|kzA5xbfqp9s)l;1t2=@)z|KNgEioXabA`fb`}-#2SWLP&F`a<_P5Ok`&D*(}@3mOnP3us|!`jq^~R4se?VCe3=fHa+uepq@?>5@un z#sbmf#Bz{}4MPA5I>=3R-AYGci0C#ksOOu=B{h$8YZ25$cZKQFF@YtfIGP0}qa1(7 z6OYso@Tp}O)+14EVwsvwG;+@bVGK>`gY^MZU0COumItCT5l9Ev+g|mX+_`EP=mGl% z1HNEhl~czd>|y4Zo~|0mwj9bYtfmP3ui9wTzZ}194%?_RLW5!dO{djvp-giG&zS;x z+ZkW=Z^j59hRxpi9qM1AX73&Pt-O;C3LcxUI^E9rT|v0)jC+LUWq*j8XwV#vI~O`rTF=DqpohvgWI9o3R3=F1pRmbpf@S*Ui^$iq!`yLxF%X>CoG&HmM@~n(%iq z?(};^jf;M7JcP#rXgM5jP~Ub&?E-2JJ0oI{%VGbzAP{o`MxPP^yk478A*M!w9sv;Y zd^2iq2%=WI*#%l7f=pCg1BP>i?(yf7Ji4)oS&0y8qz*|FGR`U4Om%zt8_K zS0yRz|Cgm|>i<7Sd4aCU2tX|u0cf-t0YVem#&SlTYSkkyC2`(e__A1ln@GkB+Kw0E zgH9X_UOS^k{b?7xzZWl1#{>f#2CWjt7C4gh8T?m$VH+#tEX|1j3L%H7oeA&XzZY!X zUZWs7R*Qspam$-RQAP{uhMF^B#3+LYAEIpNCJRt34HKDlib8>Gb@GQg!<4DLg4n`=FT$uU| zqyQymQ58II$5B_C7I;GE=(tEgsa1tT(af&h@F6yBVNkB#Tw_GwQZ4$M8_yK@wpDllW~nX@x-L%6XqftN*qK zbW7qPlp!*sF_3!z3&s6&2_Z?Y1e~y^KsagSUUi!nzd;Ncf&HKwOA6{(94j%GQ6xErz=by3@%dnj68G1czzEhe7lqCjN*0o@G1>&8ot7}*>usQSQPz%H5GowY# z7$F7m7$XJinBszbP${4KD9mOdlr^6KhWvTAMa!WvYugxN?Br?i*3td05LF7xCWBPU z#}eYK`*fOeoUH?!o6)b~-Jpa;;HRt97|t1=pqeAc+gR zBK%XGB{5u(3(sgj=m{OIwYy|NvP_*WuqJH~g5|D;lR6aUqvavkP> zwO*6c`0qK&t!G(=Xj|BGR`-IbE-<)hnb=4xBYeOPJtY7LIzlpnhTVyy+n!(B^rJ}< zfMM?J#&W_TV@6Py5Fj}&pxtKpQzrDwoIaV2#;>!5svBf)ewn!!z|GQ_c$*g!8NrX+ zD49?GX~jl^@VL&9Gb#w`pxt#Qna_l#ZMnK>jd^;sT*3+UAZ1!5axd_b%)8GVHAoJ%fX;41AGAGh~ozo zdq-VF6gs?utzR^&=2WFi5hg(xowd|DXDQKc4?5OJb!_lIx|^|NGJX zKiDHrV%tv?MK^U%QAB(7_5NQ;lI5-cSCNiNvRp3LQvdHcilX>VouYs*kfj};71+CP zk-ehayzCYfMKufxc$;Of^4iSJ%NCGdk-bmnRJ#AC`~N?5|F2Y~hFEQsNe86+f4cuC z?EiFQIBfIZyZ=k&T4{6tSCXqxFH3bfegE?;WqZiY?eqSjHNV5>-n@3KrOlmO`#zxU zShgEJyrw5IiozW@Q7~{EK5bw~$!^b{ZraMLLa;G(It37|I0(yDC%U%+7%9{oJS3Dh zji2KLWd~CUa(eiq2PCrDLcIL+Oe)m&h{aW0;U-qIAKKPqZCw4%SE6=D)ORG@ptzw2r>ps1;yaH zG`|yDGyzxftf*84WZEpuqIW#V-+dlF_G?862S?D>?z;y_tTNoF$nV77rOeF$WEbV? ze(@=(ybvC4$~Reu3h4Owk4HM$xfN+?V<(pvH=H&w(UC!}t?4AS0Txh1Z4zE;xVVr(j!r-?AIZ+-M4oo9I>*=@ss#%Fcbq!3*mHj+vW@U9eqs&RGu}FwqaT zA!mcF5f9w1BR1gfMkS5I1RMAhe76lK&;d3G5!*Ws)>nw0K9twDkK$=PVNmZT^pxSf zrNsN?aSr)JH70>hXLd{CzqGLvZY%YOj?&2Xj_xE^&$;aI1{S@+n zZGgYD#+0Du{D!V+5QX!T*hJ#NwnTV$ifO_b8$t|zw6dGFG5aUIFG}^x1%s==b{W2= z7v3Qvz=;c06f|)@Zy-6zq1R(HLobn(=wAT9ZBe?9^ATthx$;SK$5Ha$8ZzsI1ad%3&B`&Z?B=7XpM<(mpFQ`OvSlPqN zxKSQd#!+=x+u9!|m|k_sWjhp;BoJFu^k6Mb&HX7GzLHA2^_DV;UtSJag`#`HmZlhS zcfx*3to0%rM8JB<>*n)WFLCMpGTShP6Gv7c5g~rxd_L88>XhhG@K>e(2^#Q@Swc@l zC;8u78|oS+>9Wfw`y1-Q#O0Ow?oQcu!CZSt@j+BzKZ%v$@CZ8I9^iC@15&8o?W>cG zJ0^(Ti{}IVUC)0&R{P*no-e-tQI*M^-@y5Ar7ETOKc1z$K*i%CNr=?V*%?}T)8Z+q zVHZH?03g>(HyMw#Mp)mv1%Hrurgy@pEIFWXok{kyz+cI|6K=DyBP@H*5g|8&H&kx3 z$Ju+J0%4J}Qfx~%J=bpy+-aqt@!6T@D1j%Cr3xs_3*Q{IWXZi}qCxB>U;o@C>tB>1 zaO|3lU(elvCT)k`fnF0ZEOVv=sbmuJa_`Joba@eInlAaq@^k~F5;Aq~%%oIZ))JemyKUN;th)t^ z&(Aco9XY!P5Z}C`K7`9(nzkEMW@qAVpvS*K=I-vHL1p`z z+})sN3E8^=o&Fu^ySvR=j*Qpl&`TI){Qa3_Dv`aN&r`|k3IzNsR0E4xTZn3SY@5>L^OGMUKZhau3BR|q0i=UO7%gGBb5>{Q@VG~~vKF{#6K5Vhc|{YNbiF+b{xT`6 zEYh_Th(?!SVdyVD#Q|N6&d_!R5-y1AuTOOhWCxBla{!-2BVE;;EkPJ`2K6kN6TX$7 z3NO~5jB)y8jK-5Oq|(z-Bw@f(!izVrY#0^fWhx*! ze`waDDG2G0RHZ*smHtRo`Xg28k5r{UQkDKl)mQvTRT@vFB`s-5OIp&Bmb9cLEon(h XTGEo1w4^01KT`QWYhA#y0C)fZO?+Am diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..747ffb7 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst new file mode 100644 index 0000000..413a3ac --- /dev/null +++ b/docs/source/_templates/autosummary/class.rst @@ -0,0 +1,32 @@ +{{ name | escape | underline}} + +Qualified name: ``{{ fullname | escape }}`` + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ name }} + :show-inheritance: + :members: + + {% block methods %} + {%- if methods %} + .. rubric:: {{ _('Methods') }} + + .. autosummary:: + :nosignatures: + {% for item in methods if item != '__init__' and item not in inherited_members %} + ~{{ name }}.{{ item }} + {%- endfor %} + {%- endif %} + {%- endblock %} + + {% block attributes %} + {%- if attributes %} + .. rubric:: {{ _('Attributes') }} + + .. autosummary:: + {% for item in attributes %} + ~{{ name }}.{{ item }} + {%- endfor %} + {%- endif %} + {% endblock %} \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..28a518f --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,43 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +import os +import sys +from pathlib import Path + +import manim_data_structures + +# -- Path setup -------------------------------------------------------------- + +sys.path.insert(0, os.path.abspath(".")) + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Manim Data Structures' +copyright = '2022, Hammad Nasir (aka DrageelR)' +author = 'Hammad Nasir (aka DrageelR)' +release = '0.1.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + 'sphinx.ext.duration', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', +] + +templates_path = ['_templates'] +exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'furo' +html_static_path = ['_static'] +html_title = f'Manim Data Structures v{manim_data_structures.__version__}' diff --git a/docs/source/guides/index.rst b/docs/source/guides/index.rst new file mode 100644 index 0000000..202a384 --- /dev/null +++ b/docs/source/guides/index.rst @@ -0,0 +1,4 @@ +Guides +====== + +TODO: Complete this \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..f5e82f1 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,43 @@ +.. Manim Data Structures documentation master file, created by + sphinx-quickstart on Fri Nov 25 19:14:42 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Manim Data Structures +===================== + +A plugin for Manim Community Edition that provides Manim objects for common data structures. + +Installation +------------ + +Simply execute the following command to install the package: + +.. code-block:: console + + $ pip install manim-data-structures + +Usage +----- + +To import the package in your script, add the following import statement: + +.. code-block:: python + + from manim_data_structures import * + +Next Steps +---------- + +- Visit the `Guides ` section to learn how to use the library. +- Also check out the `Reference Manual ` to view detailed documentation of the classes. + + +Index +----- + +.. toctree:: + :maxdepth: 2 + + guides/index + reference/index diff --git a/docs/source/reference/arrays.rst b/docs/source/reference/arrays.rst new file mode 100644 index 0000000..8975350 --- /dev/null +++ b/docs/source/reference/arrays.rst @@ -0,0 +1,10 @@ +Arrays +====== + +.. currentmodule:: manim_data_structures + +.. autosummary:: + :toctree: generated + + ~array.MArrayElement + ~array.MArray \ No newline at end of file diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst new file mode 100644 index 0000000..228e1f3 --- /dev/null +++ b/docs/source/reference/index.rst @@ -0,0 +1,12 @@ +Reference Manual +================ + +Contains a detailed documentation of all classes in the plugin. + +Module Index +------------ + +.. toctree:: + :maxdepth: 2 + + arrays \ No newline at end of file diff --git a/src/manim_data_structures/array.py b/src/manim_data_structures/array.py index c815d98..3066438 100644 --- a/src/manim_data_structures/array.py +++ b/src/manim_data_structures/array.py @@ -1,3 +1,5 @@ +"""Contains classes to construct an array.""" + from manim import *