From e4c679058be956bd9910592150101d17b8c5c0e8 Mon Sep 17 00:00:00 2001 From: Alejandro Saucedo Date: Sun, 30 Aug 2020 15:32:16 +0100 Subject: [PATCH] Updated documentation to include multiple sections --- README.md | 2 +- docs/conf.py | 5 +- docs/genindex.rst | 4 ++ docs/images/suspicious.jfif | Bin 0 -> 14385 bytes docs/index.rst | 106 +++------------------------- docs/overview/memory-management.rst | 14 ++++ docs/overview/reference.rst | 83 ++++++++++++++++++++++ 7 files changed, 115 insertions(+), 99 deletions(-) create mode 100644 docs/genindex.rst create mode 100755 docs/images/suspicious.jfif create mode 100755 docs/overview/memory-management.rst create mode 100644 docs/overview/reference.rst diff --git a/README.md b/README.md index c8650b4e1..b749a6c2b 100644 --- a/README.md +++ b/README.md @@ -176,7 +176,7 @@ Simplified Kompute Components

- + diff --git a/docs/conf.py b/docs/conf.py index 6b3384139..a6a3de48f 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,7 +51,6 @@ templates_path = ['_templates'] # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -76,6 +75,10 @@ if html_theme == 'sphinx_material': 'globaltoc_includehidden': False, } +html_sidebars = { + "**": ["logo-text.html", "globaltoc.html", "searchbox.html"] +} + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". diff --git a/docs/genindex.rst b/docs/genindex.rst new file mode 100644 index 000000000..4eef4a23b --- /dev/null +++ b/docs/genindex.rst @@ -0,0 +1,4 @@ +.. This file is a placeholder and will be replaced + +Code index +########## diff --git a/docs/images/suspicious.jfif b/docs/images/suspicious.jfif new file mode 100755 index 0000000000000000000000000000000000000000..1e745575023131aea37163fd17cf2495d84d4e2b GIT binary patch literal 14385 zcmch-1yoz@x-J@u1gEq>fdZkpTah9qr4)h`DDKb}FYZzxNYNt2TUs27Cb$=OcPQ@e z9w3C1{(JxHu6@S3=eu*Lc-J>0+QV9 zd{p939{#xr1`rn){Vj3=0&*@|Dq61p_IB3{AjQRC!3gRDJba2rlvLErEUawo9D+i^BF{v{q+iL%LgeHX)HO7< zv~_g#OiazpEiA1*IJ>yIxqEne1%3(&4hanlkBy5@NKE?rEjcqQJLhL^UVcGYc|~Pa zbxmzuYg>CqXIFPm@95b0#N^cP>6zt~)wT7F&8_X7W27G0;CACMf_6ShDtJ zx|D-GhC3Z7Q3r}A z8(ki?_5Sq!q+5DUevtM!I-btY4Mvm9R_vdzrfIq<;x;srKNiWBC#6f@lf@Fw`Sit~ zferBg$Tv?QVPWTx?u`r(J2f0|_;Lrx z+?nZ!8cvsp_)*$D|HV`CllFwexwWX;RT_IcnMJa`*d;T&;K$3I%n%g+Y9X!PmKcmAUq+o0Fx zGs-nW!XJK5W$yr*>c7u7f27`SEy%0ASe4AWq80+oIOsbpSx}00I;MWj?#cLC!U%98 zp`rx51+b+97d>A7j$`>QKHCi>?N#iQJ99iGnXJ9}>gvN^wKyx;zw|ngZ4qLebful0 zS`ksO)4fv^!Pna?5VIw<()7H|{5;xcdvvUm&cITRDQTiA32PjanOG?*S5rwo42I!~g~JjI)DdA%OXSMzzuUs=n; zX&JiE)ej~$mI?09o2uq4-y2G5Ul%&Mto!vbDS7i)ij1nTC`H&Yb#*x=dwu78~6qd+Rn9sWn z%3tOiX&u#AAybucN_i(k_6FmBQVg`J(kzZ?i?V|10wivJ2tuy#_pM`&o%U*n;XsQR zygPvFNK<~XF>4wNha~i9Gx|qc8vdd+Hd$^1vv0Vs7kXBJzhuW&%ulRsGMq$@^W^Dy zdS*BqCg{!4K{T|s-{{q5n(%LIrt31Fu`3N~7JrrmS9eFDR%Ii8GA>LUf-my6i!a0` zZ^Q#gPGR;4roexus`9b{Ondvs#|>r1KB|qcFA}La0GwJ)!w$)SW$hWx|q&*4h zkyB(bh5!4Suu_S_-~P*`dY||uU|${aqmsu897H^#Unc7MnGzB0J%DO%McJarA6>NH z0Zx~BHx`jfwk;NBw$UsLOyGst#5+LacNUoGb+UKd$1=~=k;gH;aSRG+uBXw>38?t% z!gqv;7l}tbm&5Y)O$#w!p<BDT9;eh|Igfro|5Sp>w zx9iFXU1X2mHPm#HH7JQ;Ck{7P_jhq=K$v5JcF7+!{(5iGj6g5 z)O6p72@3lc%BuVB0N!v;*=H+ZZXMJN*9<|R9Lewz8HlO*+QPC7nIbI0b>RJInc&B! zl8*k(WSKk#7@&Ykh!klne8qe=Z*(znotGf(e+Rf1no*RKG@R5X+@N^}V3gaS3`M?C z8JRs5WGjLk9k%O(5a;9E#aTw-Cq!LGHL7=j3{5K`6-ui+z{!InWDaB@mh21fl#{)} zW}>$Co*)Xk;Q|rNxdZSrte&86n4MYM?QNV@J1gO?wf9VX_!$s&&-q#_o4WI}vp>;! zEh|D7S%u7Qfh&AfI76{Lg{KMxsRURy$S(eQ9(zLxgGcg=avAq0U|`Q`)UtW z%t9+&FN}W7&FNA=I9vL?Kav=m=qHBxAAS_`dgN3}NSNj|VtO zXP6mdwW|(QhwlKA!Ql(R3@)rgz&ileX8XJ4&=966!;rh zq}t!;Bsoe&g+vz*%f5k;SgUN*Lz^XlR3m9+g-wt}6kd}InHtxhx5qBUm?0Sd2HQGC zT(JSm@b`=|iLn^v?>oTaD~t0Y&fwnT?pAvH{Y*|2u5ZDIc{Fg+FgGgx26%d4I>|$Rko-OHu2Hm%sKzE@ z)HmMt;j|t|Xgf$26MsqRhxw_QKJiY-QwFl)z;`3%-{>>}x zoV8Wj260US*yEQCLo;Wy?D8m38g#WINmmqd)!eRGp+JaHn)WdWfsoXa+X;l z_Luhkt%d(I62g2DI#%vZm|^C|<38e#FYPW1I6U$Kn@sfuwlj4DY$N95qtJ@9SRH-WH3dnCdKglvBid%-tH!mM8eHLI*xECHY$_l{d|#SJZ6jgnh*%9(I>3n+j#- z&kY$!!MEoWL~rN4#gE3jTq}~QBF8h)4D7sA!d^BXCNu{-&T_sxNgW(zT34TQORC${A=%O<|Kha;{!=! zfx)ca?RO}2h@;J&hM3ru5>h=TdK$d~mD&^6tYa%KlV>*d{%E^{R6mO~ z*KOdogd&8r37Je?L57Qbc90G0Ot^FFwc@mXpSx3#9USk)<3q>;8k1v2upd0CiKmN$ zzi3s)vgzqLAtsE2Lvx|{1g*U_%1eKn$*K}P;*q&&@?w}EO33h@i|S=|q?rt|+w}HBM|Joa z`w>&DzT5L$>1x#V>+rKwPtez*zIkBVb?{;3c2z9@&Msw?%FTg<$gWNwNpR{>^&hwU z59c04)B)=~tWIT5nq<{R9(~ZuaX&g#;xZd8KG-v-$#X_WzVdr;@Kar9UF6FV0n;EM z{Z~6j8`}8K-Tc{*kxoNgDu|~|al<>o=Br3c{Q+xq03MrgK~##f!;CSy7ctY861+ee zTfUWG|H^N6wk#vX@{g{yR58=O?fcIFCrCgqIT`vosFlWW;Ud#RDLHnM8;44FfE8@5 zi5bJknxja0i(V=U@#YXtj+nsi)eVE_JXpzx9G0VrgyQOAN!{BcEcnS~j!3Idon z@;cbk?n%H31qtDC_6Q$}$$^sE$Ikp8HQV2{+yBeR4dD{L#8+FPG*@rY&5{SMEsbrZ zi-NXIA8lX1$FYG|UYOXd8SA`vn_#Ca+B zB1%b_bxi1iwpOVcY{OxSG`FulZN+#6iApi^Ol-)VYvU3-`1;!Y;&oZy`gzPl#PM8I zuFYwT9r3uClf zXE07cInJr|X2^4BMP$j@WWDxovLX>adGfB=DkeOKPhY3?sx{vM@{@Q9hcXB`OS3g1 zMdDwn?HOKhz&F6{ziE>7!eiCrVtIZT&}Yu?q18kx9i0dR{vFY#T5X`vFVqqGE(Eq2 z!!etYw5S5Q9U?F`w^VZ6TpXnSM9%;LT#5Tqg}EZi3UY%mAvGSZlX}kXL)%f)X8U>$ zbYb14iXu19Jf`q>UGA$DvK0`xe!Y*1ySH}xwe%+UHtisFUJ_PSS6v^fhBhhvFuYc;{~fU_DHcJc7C@ln(Hn!_sJqE1NtF}L>lh8uqm z*+_?=axqz6*{dxlc!U5Y$jjBi7jMF%GIg_!`ty5hbN8|7=mn`$K?N22730qO-b+?G zZM%@q%HGFKMvWOVWE#|eB|Co-p8tm6_C~>@3c7bRCz{R7BmQCyY?1zKNRDF4fB zxtX~EEaiwC4_}lE})ZM*X6O(wU4Aa5e2O*GW1_*Zr=;%+$Uh3( zeP$m@bn@|(KEVF?o4Ro(F8ea7a14d9WRm}px}a=E4{Q{@;Uz;>kuYrffAWaj%x@9j zWf~{Bxlt{i%$57`Fh|?UX~u*joJq4aI!X1z!%mA32~CM9;H#Ae@zM0S)r8=n zt{143=+g;xr)a^~hMH6-J^JP1)a+KAjBo$RQ(-`uNc7g5mc@?h4CiK4n8&%XhVWwL z@WQ@5wqkt89bGV`s!=SMLX9N-m^-7AT6E0&?VPyAeiBX$vZWeVhhjeCrL`85Ehdh6 z_ft8^{oY!?5uig=R~UN^qCS58J{bc;YRwNrGMi8kznWFwmcj3gT#i&4`9Y{XWQSW4tLW?)CjaeOV%u*C`Q}29C zF*Fk1(w-WQ){AY39Af(CjQ!u_RQ^hqn~!Ba&*?I+Q9aUg_T1`g^Yp|nf#ecOCN%vc zjX&d%#T9D6AB>byb>VAQ)!eSL&o55@P*}7rEHX`JotxkUJeq@?G|}BcCM!7yk+kBL z*B6D$S2|aZJZsA4hwFHjqc4*JQTtxZKD4jmez|#NZCc6K%;>{F1?V}H3;oNi{cj>@ z(_3XZPiWSWOZ@!=_mpt??fi`=sRG1adUo58oLn_7u#Uw+-JnbqjOP))f>6rZX~~+j z5n=TF^}H3*!V2ze>evy5m(?^;ZJid!tr+t1?}%B+^AMVRd#4h=HaJ|_+J9r)n`yeB<&se?lPC=P>TE(?GSuig%ym|Y-%r|OfVP=Pl z``}%aCG%s`C{4l$$>8ivzqwOdXxpPkT2CQE%3pPM&aO6VH{vw zlNno<$8Xo{cC5#{u>?x6b;#c~-70g=pF%mB{W0V`$i40_VdDRC&xEkAu zYghYsir^6n2|ieu+0r0oKJA?_Q{c#vOp< zaAs5HqbS~KMPG?&D9DGHIJdHG`tT9r>1L_Jh0b@_&*D>vp$wT;Ha3|y z@rjb_F*RN|xt6V>T=h^|o=!(prs7u(luWsXaR=SQXz|ML52Fu6p|=3)9K7c-#MxSVzcWiz zBE0FEPRT>>0QKZ8cYtYjV8kyP=msa{b%z7^LZR49vfpSX?Ud0syhDZDL;l*D!sPa3 z8%=z%6*^k$VIfXj4MlslC^l$NGWpNs?Sc!W_C|ceUwN!iMUG1CKIV)@x{Q@TRNv@) z;>6LyNbuLvq9V+G8^AeqX1hRnY`YQKFPl>MUY~oOe3ttWsz2nY_ywGEg(&MY_fws~ z^_nrBVSCzFPWOAEIGCrfE%8Q3xo9bVkA{Bnb_$FfJ7LsV_xD2Xd|h?$(ntF@?Y_Y9 zQXL^%;!g+gPnm^=JJfcm^@qjWu%zlVhC)zg+EW6_~eBP$a9MdWwuBb^=uGiD_0Y3Sp{3TFr zWZ;z>n*3XGvEs@hnDN;{$v5X{#C`Zh-}3(aZ3;Xi%VTm!(fZSammBQEq{9Ie-e_vU zBtrc_qbtzBO8!O2g48OiA2p@fi z*6^R`-5U%=dBqpB7`rk+82J^(_0j(+kJDleUPJXAN9De|d^_>PlY#cL|0bGfI@WjX z-yL+hHEt8DJ6@a1c1pWYZ8JIHHu|XxUZ{iir(LCLS%Ky`KJQgt+6=wPOp40-;t3q5 zi%;05!7$*75O}gEfgN&Q4ZpH|9fa&5R$ep{jci^i6TB?7 z^UfVJEMbil&aU3iD5}~Yz_vNhK*}nWrcytVuaBc>yGI1WL?2hT4~C2Y55FICu#dG3 zdhG>ilPjlwFV7nHhAi)MI{a$-qyS!zU>*Fvr6#d@+~FM3r9Ja0n1sagQBs)&#+vrq z=lu?t*ER5B2*PBUR>UUBu_u2nN^#+bbo~t06;xniM#|pSmb%TB@J;(KE{Dv{&u1C{ zZ5O^TQP-(1$Cb=STb{4IAe~CaIJ&lip~h8Ps}7PecudIdLVhGyQ{7c%G?~$0*C7+z z9vCNC`VNq;oj1mmjH~TE+C@#W5;O7W)FgZ>f{`|+ha)bjeUNx@862>JIcTe}bSW^$ zfr)ta8M*tgi;nI{JIF;QxepR~Sjsb{#yAHW8FKE>PbMHim&g^&vE;QV{I9l`kc=zx?zB5Wtwmql|~W7hgPx35g!;E*-po>edx2{kBB*TK)DUW1B!bqfZTR6-{K zDNj2%#fs+@b5jJK3wJXaPu72jK0*j=`4iXwjP=4}m5W~IA+m0BwsNY69X$C4Z6FMz zM-C?|vmb=3#ZIRxpLo9=y#uTs$_A>2c{P-EG4j#g0Y<)xphR`Wx+1cEjh;W})fg$Z zv4hid((T3TYJ{luaTNN;92#xvCL@K*EoY`?o`h>EiJdnmkY6MO4azQ0mR*n?etgWO zq^Miob*4hSeQgx@b6W6`h*yM>3pz9>pOtd^!(amJN+yowPr6IgtUQa4#90QwYeAj){#KSNc&BC9zbl(ANfk}6OXl+rEj!+h^WN^s& zPqqDqllVG)j+lYadu@5fd(= zjbr;#dzt;Dh|oDy<@ZADdO?j3&ohVg;MyxhDd(4;&cE7BENI?WKJJPgl_4x-^aDP} zf#R=%%TZiCsPYbe7U<^pk~_fg6Edg?Qe_aj%x8ad;~3p%&LLTlR6{GE{l{>jSk$^+#mu35%5XrX%Fj zPbmJZE=ou*I_XVGEoNp(xhUv}Z5UNC;botfN>^~h3L7y}Yve_gnx$2FxXo+>wE{%u zAf*9XAjG~-$V&U0vY(~P`!5H|gDt;;SIf*IP?ednAD^{_J6N=Th@Kz2j$mG*dEpjc*cR0Lc8yc|10-R@|phB#nYHd z_*9zh0_)1+YVurd;{EB_fHKd%H9ttxaP>-CnZi3EgICb`ea1f9;PWvtp9fnDTh~G( zqEzB1qjG;{ry8-#0>eL;~J&~)xJHShLW@B*X`ge%Gg2Av#H)nrk zA@>Jknm)5^1A>nY?`J3{)lfR55{&&<&D}R4xe_0zeohgs;t|Icdw|>NX%nXi$Xirn zwb-$OpycM{Rpc`{Y3gZ|-*a4t_a&Y#5n;X{oqHW{2hdnfK3JF1S!{}->INC9G=11* zNu8MyPF_LlxTh71YviMy!578czYt+7hIYE#-cPdS7_ssj>SWw#R^3Lu6Og)%38{^Q zQ$n5;n;q2a?T0A~uXs#n_t3`d23}$}ir;AkJ(NH*z#0hE=^f|;BzdmA&cRyKH|G

!ZlYs_y zm=Pbb_LwGw8e|WYi)3-2OX`n==2Q(%Iy8Kg^Om+DIfL&(7zjxkyNcBJ;zQ2tL(6m{ zdZY-G))*7>Xp=7Yh;FDT9?XlARmvwBp))DU!s`e88!@xYAcYIkm#c*6PAq zd0m{HJwPp|7PlBHtiK*TYv zhvaatI9lZ(RYyx)h92C)1-Hp(%T2v(>xi2W=TZfTp%o%{LjLdFWF{lS`JxM`ZIF>r zM1Sz}jx1iP-R710x@8ojv4GXJZxV%`^-T;X!#&-skRVE$lXjDBLk-8L@$tG{#(2v2 zon?)KD@j7zWUEKd2y|dv$ewlEmzEQH(wwFVo+mZ5IOESbHNA;G=E?C$K#GkPdX-mV z>dOMRn9{(R__-#lo-Xx@oQgxl3oZ86SXw*FKWJn#+~4aoZx-uqpEZ#q?6o*)8yBcr?!$sQgHe`xir%RRAV7&q!0 z9)td@24kL87Vu=iqGhS+!H!3q!9+jq+;?mH1wLRY{wwKon587hLyaD*(9>bQAHDu+ z`9Aq}7k4gbMdiRae?yVKkav0PW^pV0bD?FCLtW%I@cA_Gw9tx4EpkLImbb_T4i*x6 z>Os=dk4xd4f3BEc20qM$Z0ouklQ4XCnPJIywSBh!U}+tX_E)#xJ9OJN*`6m8MOC@; zsT}_pk)D<%XbE?k(i%V89oj1?1*MSX`n0|I_j76I)PB#-7AZkD z-0tMf$mimAzx08obwPgD5`Bi}K8Dc9@^y!6bvaIgjyl~57fyt#y9(e@;u2x(QGh~p z-W;b}VtK?5J$n4Ya;FvJ61q#ZCV`q-;}tJk7;0YXX3++SJCWRQcV)m2T2XE4RpBR{X32PB0!O{` zBjYEy2OL%z0W0ipQw0;LG_p&(Gh)Us=%-Q_x9f5P>>q27R1amn-r=>SNhH1JyPKwR zP;D1-3%i|}vE}XGyv(!y1ts(1CRceqzUTV!nSD|AJXs)N?&Fm&K3i*aS;+IkguyZ8 z{v9PD7c^P$BnZve0%^MePV!3t@#GWRmp7;fpa%vO6U(1O4SRG3qhf z&a%LmVYO%crs1A=9MuM{F+uCGK_ekev<>=Uf zSgz{xI&O>&@5PwHw|1y#Y|Y+%k=nDSlFeGan%U_R_+5*$g2Utop6SXpL8%OE)GELm zV7#H%T!q3O?t2BhpzedM0x`RMlLG0DS#W>4XQ?n&4Co>xx52154C#o3F}3 z3^_m-v;)ffYZ(YzW@f6#etPPPdgxN*Iy5t4_4sF;UAIy;yr0%?WF$q@F25AGF&3-q^hlUw& z5XsJhbjAWP10=_&TCM}b6DTfZYMJW=^YUN^Mer#f*ubyt`Sb)P%-xFQ?`cChocfNr zJ`phISEW-nsiSMyG15XsOJ+++G^BgbP-sls)>L((yE+1@)w?jmujpV1}PhHu21KCIWs4 zo2#Igb*=HPKA9bez5_t|jQkCNe!jLUodRx8Wx=99g%+pAwGfSpCz2KpbyHXKG>WEINKT zo<$m?_ILX*DyBP{CbXC)yocc#A-srB(|^y(GMyL?DYP;`jJmMLpL@w=*KA_%aJ(Tv z>_-0e?J7dqIWW2qwRrqt@o-zq9pK9LHk=)hcIB6a+jv2&je;Q*BW&$G^GuXZ{r<((xg~E=KF!HV(?{f4iAd_9xST* z9~!z`3kSKTRahlHu&CE>e|-9e$kf2&aqGjt&+POjskWO5j%gNLV1*impo1|6$95sp zk+$tB7Dndv_RNpdeG;*Ur^1PA$oZZFXwPV2HHet;bz@TD+>6_nb1chei+JdTS+qhy zKGrKuB(^@v*mb3IkM{ZQ?>rsj0iY|UU!3z9k(sv>8B0?wTG0(mma3{!5+eLe!&Pg( zsp*$kUgMS9Mw_YsXj)XnR{(;;iO4Ww9CHQ;TQ3#9%+6)Zmnu)#8#dIQNoXa0UkOd= zfET5i)u~r>OX;9rafLXPBe8H^SI>xLdX?}+Yt8c1*2Ma%Q}46Ng7LE>&jcIBOQV#i zbn>@F+2rpM%;*D19Avm1N_j&CU+Q(LJ6rvzcyRAG=)e^z1*<0^+jjSe+C&>Dem~Sj zfBMFkUb|!EBpKoE0*@|lH9zCWA2?|OpNec{WAPDY3zYPheUYMTcT_Zz+6{7U`5N864-c;$kjI`1Lo%Arr6-H(xPcqy(Ca_W1h&}UGb}3kt`7D8 zTn&jev}rsYcBv;DbJ-W`08&hjbpAeM5fS%gO0Mb;g&(x2lBfJW(^QRB8U5kObUg`- zuuC3m^J>dzQ>1Zgj;cwPk-dFt)UW;nHh01_@yxiix8Osgoj=DHl0+?Y{ZZtn@AjgQoNaV_v==uF1bHDX;F$&ujAv?l_6whLa5IpjM ztEipEUV(#w%LWTYB;gW<)>-$Izhwn7Z;YLk!wG8{YsKIA3QcCuU8z^7wlBq#Wf!wk zQ3C^tD=lZ=B)W~+EIsCdlR0cbVJD+R5kJMe|K@&9){Zy@KjUvv(pEKCoSxI5}+rs~7(C z3uKFOG$#U|yxD2XP!qrvDu-LW+0`?f|MZoJ;jr5I4!{L}7;nGj6IT3u#FZ+eWa4bM zKW8D1XpkIrndl#1jKn%VW2ohifBuVH4yg#)9!Ys7wy6C*hc{@a!7IyTx%c36dlL9` z@`4;Vbq|87T+jv`9guLo@Kn+Nezmwmss`S&E`j&n0opBiKnOW>tZbkAJ7E5IM)ooY z*+?JZNcNZBNSe|bLU;t)wdJb5pi|7V+Fy=zEow3O`GGQVhDV0e>Rh3`QW0_1)7kt*+C)a~H;*ue~8)TXs z$u>QCnc-*A5`X6RC#VDH17ui;&|Gey>|c9LyNVmmX74R2-%-{+dL-mLGhB%^i`v%a zjUu=6Yv!~1Ny{!4Dmg&3t4;1nq1yr<+k#e(Rpt0{b`^cZb-W2OIh?bra~}U`i)AV21|#Kr#3z!m1Not2{uD%1C2~Z be;&#?EAiq#AD+7hRT)>6VG)Ew@23A3D<~wV literal 0 HcmV?d00001 diff --git a/docs/index.rst b/docs/index.rst index 35a411b92..995b56cf7 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,105 +1,17 @@ -.. Vulkan Kompute documentation master file, created by - sphinx-quickstart on Fri Aug 28 06:42:00 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. -Welcome to Vulkan Kompute's documentation! +Kompute Docs Home ========================================== .. mdinclude:: ../README.md +Index +-------- + .. toctree:: - :maxdepth: 2 - :caption: Contents: + :maxdepth: 2 + :titlesonly: + Class Reference + Memory management principles + Code Index -Reference -======== - -You can also go directoy to the `raw doxygen docs `_ - -Overview of entire dependencies and their relationship with vulkan component ownership. - -.. image:: images/kompute-vulkan-architecture.jpg - :width: 100% - -Manager -------- - -.. doxygenclass:: kp::Manager - :members: - -.. image:: images/kompute-vulkan-architecture-manager.jpg - :width: 100% - -Sequence -------- - -.. doxygenclass:: kp::Sequence - :members: - -.. image:: images/kompute-vulkan-architecture-sequence.jpg - :width: 100% - -Tensor -------- - -.. doxygenclass:: kp::Tensor - :members: - -.. image:: images/kompute-vulkan-architecture-tensor.jpg - :width: 100% - -Algorithm -------- - -.. doxygenclass:: kp::Algorithm - :members: - -.. image:: images/kompute-vulkan-architecture-algorithm.jpg - :width: 100% - -OpBase -------- - -.. doxygenclass:: kp::OpBase - :members: - -.. image:: images/kompute-vulkan-architecture-operations.jpg - :width: 100% - -OpAlgoBase -------- - -.. doxygenclass:: kp::OpAlgoBase - :members: - -.. image:: images/kompute-vulkan-architecture-opmult.jpg - :width: 100% - -OpMult -------- - -.. doxygenclass:: kp::OpMult - :members: - -.. image:: images/kompute-vulkan-architecture-opmult.jpg - :width: 100% - -OpCreateTensor -------- - -.. doxygenclass:: kp::OpCreateTensor - :members: - -.. image:: images/kompute-vulkan-architecture-opcreatetensor.jpg - :width: 100% - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/overview/memory-management.rst b/docs/overview/memory-management.rst new file mode 100755 index 000000000..693214682 --- /dev/null +++ b/docs/overview/memory-management.rst @@ -0,0 +1,14 @@ + +Memory Management Principles +===================== + +The principle in Vulkan Kompute on memory management is summarised as follows: +* Explicit is better than implicit for specifying memory management +* Interfaces for memory management are constant until freed +* Memory management responsibilities are acyclic from static object references + +Vulkan Kompute is responsible for managing both the CPU and GPU memory allocations and resources, and is important that they are able to explicitly define when these objects are released or destroyed. Similarly, it's important that the memory resources created by the application are released safely. + +Vulkan Kompute is built with the BYOV principle in mind (Bring your own Vulkan). This means that even though the top level resources are managing the memory to its owned resources, they themselves may not have full ownership of the GPU / Vulkan components themselves. + + diff --git a/docs/overview/reference.rst b/docs/overview/reference.rst new file mode 100644 index 000000000..6711f680d --- /dev/null +++ b/docs/overview/reference.rst @@ -0,0 +1,83 @@ + +Reference +======== + +This section provides a breakdown of the cpp classes and what each of their functions provide. It is partially generated and augomented from the Doxygen autodoc content. You can also go directly to the `raw doxygen docs `_. + +Below is a diagram that provides insights on the relationship between Vulkan Kompute objects and Vulkan resources, which primarily encompass ownership of either CPU and/or GPU memory. + +.. image:: ../images/kompute-vulkan-architecture.jpg + :width: 100% + +Manager +------- + +.. doxygenclass:: kp::Manager + :members: + +.. image:: ../images/kompute-vulkan-architecture-manager.jpg + :width: 100% + +Sequence +------- + +.. doxygenclass:: kp::Sequence + :members: + +.. image:: ../images/kompute-vulkan-architecture-sequence.jpg + :width: 100% + +Tensor +------- + +.. doxygenclass:: kp::Tensor + :members: + +.. image:: ../images/kompute-vulkan-architecture-tensor.jpg + :width: 100% + +Algorithm +------- + +.. doxygenclass:: kp::Algorithm + :members: + +.. image:: ../images/kompute-vulkan-architecture-algorithm.jpg + :width: 100% + +OpBase +------- + +.. doxygenclass:: kp::OpBase + :members: + +.. image:: ../images/kompute-vulkan-architecture-operations.jpg + :width: 100% + +OpAlgoBase +------- + +.. doxygenclass:: kp::OpAlgoBase + :members: + +.. image:: ../images/kompute-vulkan-architecture-opmult.jpg + :width: 100% + +OpMult +------- + +.. doxygenclass:: kp::OpMult + :members: + +.. image:: ../images/kompute-vulkan-architecture-opmult.jpg + :width: 100% + +OpCreateTensor +------- + +.. doxygenclass:: kp::OpCreateTensor + :members: + +.. image:: ../images/kompute-vulkan-architecture-opcreatetensor.jpg + :width: 100% +