From 228828bd42999184e04632007f1fc66372eee494 Mon Sep 17 00:00:00 2001 From: Michael Date: Tue, 6 Dec 2022 23:17:23 +0100 Subject: [PATCH] Report section and python API reference (#400) * started python API reference guide * Added test to the API reference guide * Added Price break * added context variables to the build section * Cleand up build section and added new example * Fine tuning * fixed picture * removed unfinished python reference guide --- docs/assets/images/build/report-61.png | Bin 0 -> 16162 bytes docs/report/build.md | 327 +++++++++++++++++++------ docs/report/context_variables.md | 34 +-- 3 files changed, 253 insertions(+), 108 deletions(-) create mode 100644 docs/assets/images/build/report-61.png diff --git a/docs/assets/images/build/report-61.png b/docs/assets/images/build/report-61.png new file mode 100644 index 0000000000000000000000000000000000000000..483433d076ded6f8cff3ff08d973c59ddcb524e4 GIT binary patch literal 16162 zcmb`ucQ~9~xG$V0f*@K1L1NS(f@q_KXhHN|qemBJ^b#RzjEG)_=$+`Dh~CC%GrH)* zsH68YlJ`A(f8X`(^X+q;^9LT!weGd+}f1+DJxWp^mo3#IDul~2XY^N=0%NX}{7&B2N8UIu=TIQ5- zmp`2VEU08*X%d z&6`h(2bbeWllKalbBhk zo92rwyV>*FZ$|5iP@siEM3rdQP(F!rP*4nEi&j`(j#C?ZnD$n9@0CYmj2^*N)+0>o zvotk9NyUl!3>`(@(@=x85W}vk6*6Ze+i#>D)a^T@RUp|0lc}%6+a}2}L>fzq*Q{Jd zVN_pa$WsJ#-Fno+plWa;U>X@8CVnN)Z6klepT@Q-5U_7rp!Ig@EKs05Xv9ioz%0yWjF0VHf;{wY zM>MVd!eH>ph(WHgLz59PA&i0P6}wgsZsECViZaajrccF^CEbA(1aw@|R+_WSbhCxk z9c)#LhK!yR{p^NQY4LBx0Z$cA8npz@x+pCSB`3x<07m3C6+Et@Z&3z`PoEuMzR-9A z`NT)i{yLi@-0&?!rRRp(5{kw7dz%~WrOZARL2#PuVOk3r*uC*B74RaABpOH(DH2c! zmNp+d7|ckQTXp(ct4PBXyw86IVzU zq-uMg;?aVE;|>8%;d3=|qF_Rgfq}Fo;tytWcxlM?`>blL;N!KW&im;NzGdz@41N5P zdmOJ7_h1Pu&gpG#P(V)w5z+(PMeDBm4jnVCa*R{yW6n;V>0E=?yC=B%W4-92V>mQa zAnk4QQ*<#Yl7wO?Z^&56N4oMyT(9kNfM(o1Jd5aY8&$J?vO2iQP~YldbJR3AOKBDA zK1(87E#GW^)rFWx_6lSXu^+wHj>Y-ZR?yH|N?1J(ENUD_sT2$Y6;pRlJmeRV;I~ZY z&kV(MEJB^6h2|#Ma;Pq(ltAr#5;n-PNIN$JElA@tmC-<+HZwG1j8|Iu7C~irIIU*0 zL@YSRdCoJf7%;oc&RbbYRP|8T21lMRn3b!NuBg1$W~Zum-u!A2_OoUY58Y zPgpb!zZcb6J^+AZ#G`1SE|=Q9BS7(8dcwWF4q?9K7fmA-C8O^nxywsfTxL8wja79y zb89Z&r}Qv;|Kf(K;_{z3?7u&5{QXqwxoH?smWRl0VG&AurvFRM#^tk8B}?N`1m-@} z%jn?j=tJ6G_dT$`(rR5(3w8S5^vb|=E{;&}7ChgN`L-;Z`+6NA4Zq{W&?mEG8jx7A zpJ^a0Kq3CQ&*2#7xjiwDi$eo!c?d`$vUM_FczGc=4i11d06;Ne&Jz3NYLYXx+l*X9 z?W-b!m35nq(Vp6;^uphOTO(AvzAROH=k5d`hZb0#7fyZxfb{+kZpT7M z;~@WRsBGc|{n_r@sHxIDlM8l=MX0+`hk&$01EhAyl4T9j%<)rtY7>$EWjp9qmk)5E z?`g81SRAe_KPBn~8r^8-v2{X>ns%j~=)hg2a&b!bkD_C(OuaM|oprFX64HpJ%)E}S<7(y0vI3)FY- z=5X7<`kE+_Uo3V$ukSQK3PBsNX^R_OU?3*=f#)4UCxbk|bHa>cS`y^C+>;G~tud^l z2HyL}QGXBk_^aV!)8j&cCJD!w75|-4p4_HB26{-gkWt=vP7@havdoX&)vu|mbLcKtCcII zkcF!f?&GVCW500jQ{%TpteN+rcp!$O=B=pgk}M_L`LK?OwP^zvQ@&!M4+e`@N*GL% zU(w=~-x+ezbYsQl?fnp*UU;G$%PWc^f7kN6E8G{GW9|4~q)2SXx$w1XsAtlGavJmI zQnQjL_3AyGITKU-ukT)r>vZ{mqPNq<_v+Xqj4C94|80@i!&$=Bf{ z#b;O%Ldoyx<$YR^&$a&HTX4lv)aJ^Yh1GOEmfFrY`ip6ez>4cnoZT{*vqrxxJl7yQ za)#ywyU+7U@2>k>uNN8ZX+JLyf|ODfV%;A~alLWGvpIpH*GG1wb!FsRbYokj`MK%4V)(J-;uw_$N-?WqcY4u~S2#<_T%D{%v2g0J zITF3|D<{L&QCW7CS-T8;jB~53YK04#gucx8Y3)MbMO4L^6x@e~4hnOrMjx?ATIoy- zfP?z1@(pCkmDpO>Q1IO`+n!-=WN$|2RZ9>1$?vJLLggZ(rXZS}UY7Jd!z27}Za6xY zp*=MBMm!oSJj2TF0&55FUhfX$CpizG>XfUKQkP=vMaut9(OJNooOD*bL7WQ{jk@l8aJt9Ky2eanHs&J@CT2e*n zN)u}goe$=fMiVa>+j7WdORe#Mn1_cbRc!5#a?>G(F4jrbBW4T?bi=^i8%-qN?PcGi z9@BSIaI=T<^uei&bNS=~vQO1p!$d#79H?C5{-7sv3?#Nr^_dbnboyA0`+n6Z%%>aI zS-M&49|7I$bW$J9Uw!ywBZ|p%WSa}=-F_d#^jC%wDUX}?8lui1bzij2<`M&yLW1NE zUQNroEdFU&FN2pUMK>e%J+(xN@4}Xk^D5!)^F4o^C;|p`fxm}lEK7UMKQI#iuRvQk zD#mi{J_bOO?D#y@@p)Z_;cqjAAlX`b7>rZn;G?d4)z`PY_MUbdCC7xi zz??@Zo@$F%ES6lPWz&TY6gwbFTq&Y&~B3Z{|P&r%ge-X_!0bS7kQ^B=fP z=Kq|_^}-q2zuQqvi=6GbHYEQf5!1y$THpAN=l|NLzsvh)H^A%k!Sxry-*{a)qE1&r z$?jg59r)=3dP*WXK3-^!rgts&tV^vF?My6t<~}@_B4a^>8ATFue_Nl_xeqC&P|oOD ze1pED^AsFHK0~~XCzzc%6zZrvT!U_xE3h>agDaI}`}NX+k=S-UYj8#WRXFw(U+@MH ztv{x`7YCWC+Wjy@xU6@&K+hsAn~vIbR|A&PKDRV1Q}dyq5OOs?Lx)xw1Yf9q$*SiU zGeM{5_^5-j!|5VfGBf+{m2WO*d;XMwj;R40KY8eA-Fd_4B0sSFbEL3y4f@VI z@hY;*0U;6DC0IV+9fY;$f3mr2j{y4af<&7~Jlxy<2;l|h(?u4)ySw*;!^gAD1SOae zy|p{;JA+iCyo%RE36=|GnH{(nbxK-ZNFbaJe{TirwrvGRs&Is-Mow|%!#_yL9=boq zJJ2-t_&}6gH8FDja`7suO70;r3hF4?MM68VSO#C?UeEaaGPfqq!_)TQm7&&ZsxJi) zvLT$&WtKi-m@Xw+IXWDwDHb#KYxW}q04(oXlv62nP(u#`bCB^J8L9k}gebvuGIo6N zlJ!1x0U8qLh6hdi08JYri=AkkOWb<|6NWX;on)3r1;t(!IHXPJ{Q?J(uTZJw2^DU) za({xnKEhwuKoc~{oGSTCyrq6R{oN(|-3Hsa0x^HBFi6LJgRKz|NVr9W&3FHpoUO;S z`|e+SaL=yYCw4mjNrJIYIi#KT7cQtT5ea^>nA@TiJbQR8SE83$E&dA!3qcA;TFrNG z-R-}Q(K90CK(#{!N^!E6LZFn8+01$4FNKSQX?QyRaWsrYv|?&#G>d^L}6a0aGq54%+~lYaLdNjbs|%b?1J)s=51s7|!om*P7xN z1A%{)?_1jo?<%rsP|R6XTQ)j%|}-X z;Y{3dV%_gBSO411@17lBv0tG`&z?dlEcb8D7iXS{#9Tek)bKZSN=Zw%@LDdu=Z@;Ar|sd#myZJioI`R)dR@pJ~i}vx%b2- z3zBK4p$pkQ7elK=*I&mP#eM=>mmdC?qY}jIJ6=g?h}!`j;HMWSNo(};leD_K3gInC zV6kkIXtSKz%XvOxRAE9e#qi<++OasjRlcd-ajcT^qyWHvnZMhFuy#--cU1Ivxdj-$ zZP4|a4~VqZ>WI|7uR*fFzg|?!+>CN_$X4ji`$}xGne}iF5-i_uQ)Aj>94Ori)YWW!z zLwYW=8{%KJU8M6e3+3Pbi@{6}h@q1a4O6x`c{Sz+z=u+`}Qh^k=&e3j|K*y$4 z9fNUU`DvRu6)+mn18f(yc@`?uQH+9PU9ggKGq6+iH2N&8?u$9!A#^G|v!if1>TRaG zy)v@v<<4@XmY6&UVDPrDBg_CUr)6B-2k$8)YGMUpzl_mAP_{)?nPzhcyXl%4?4lCF zw0W`WilC)lW@ltf)>Cjg2&yYmhGxZi0ayFJxl)N-Cxy@JZWeD73T%VWJ1NLI`6f}#mubWq z|4O%$4e>ml$jJaSM~|0DleP4-G^e8+OJTkyQx-}k$C%^|1!;~mXEffB+Z_;dX=cm8 z_D}}#!w_Ri{Zk3exeLAt^bZRjmUzwzXXg>1T_Q^O7BCta`cmet^5}0M4R+rmzNTIv z&iZ?;t`w`Bo$YDGFo{1r?_W1!i&UHW@&M`aR<&`!=5UqPg@mcVT8LgpsIFQ`Ii4;0 zm4KubzBUfhR>KuRiML*Q5~4RYTLf+%HjjT``h&G6UQX#HB^^_S`n@tg4&yf0}={WC+?fw)EzoxE70*{u|+5uh5njv?+7j z=S4t*U+_T_2DSeX+$gd>dJmJA`+cu7Oo%HYFJkPQ?vA3r;y_;7Yz8D=7D_Eacc1~W z^W+5E@zskHf*YHR&s}G?f_wH=&Tds){@xMwFC00+i~4}c)3v$dF{(ad;zCqBoCeg{ zP5WHAA5gH8`x*9QyEoirfj6Mh6i6VfL{}yHNn|~L9n>Lzpoz!DuITRN-BcwR97zS1 ziONfWg<7SE*mzy{H8x>nRDio6mPDgXUYbpIE_Mu4aoDS!G?S&lQh6Qdz`%5BY$wB^9?G$(oBV~DD(4Au+k@R4A~g&uZj}bf zRLd0V#-mux)dAg^sTmO6X2sAus0-YcFk=!bwQh|V%6uP7Tiv%*r3t4Q|8q$4Z3>;9 zI_LtDjmKAPuy+!AcyVV*RoIhd757T_lQ2)oSY7?=HZ9lUf4%k=5*z!Z338Y{%P-z+Cx!VePBi2fezz_h2-j*Pb&ic`;)G^XnCS72Q--l zNo&lj)n)Ly3;D{56nIop8ZmV(Kxd;B^Ds?hyWdD}tf*67M13rs?0k;0lWSrUENUoF zyhkJ+xEtv$aKU#6vK5r1+6X-9@m;PKJh2NiLZMgvcUgM|r7CxNFq2)CR9 z08IFt9(kf=ph|CCynE$XV#MBgOva*BYSgAItEGGYJMXThgu2`zsIf^8;&}$p> zakpGG*~QlwevOG>m9#1VM*S27TDGoyzR7Y(k1{VbLu_Y2IFsZ?D5x4P4{e4H%#D{x z!rtzU3>VTySOv_04mh& zKAw@~s>Vix{GQJ>uj4{&jQ9z*4`PT=9Uu&-b0b5MVS7qzJ1*$!;4c97 zvJ}4rnYU5IMLKGXZEfK;FE)bilV>qmOW|kmzORilGAfi=6=bY*yuS=i-uPn3L(q1m zDXFYsncen~k^cj{Q4ep9rVNn+3^=@fcrzvK=8$~ zWH5Y@8)7F|{`5N5|DSa&%C#@i`F))t#87MWBi(}=d`dZ6QT?mIx8Zf!Fce)RuhBH! z?qZWCKh1|MB7KpCp7?YZ1?Z3{os|?41ZM6Yjlj|UN=( z-(w=R>C*C`3S5gQ57^yhv19CJvn$fHU%Yews7)!MOfV5uaVhXyu1U|M~{orb;Zb@Sm&%HMXqPi={*b2 zU?6?36$1x>I?dOsU1+uBSK=x#p7VD>%pc4vJVkQQeD-vDX*;TfvbxX0z0F0Di5RVv zC+gY)I@TF46|G7imA$7ru!YxELB8TLe)<%mNrBXcP;dB7d% zu-_pxNSz3ddp5WFP* zs`Ts27=0i%4Gl=$WHJNg*_uLiHaV?C+Cvt>U}qC`1|Df@`Q7=$n_nh-Zos0+moG;`ipB)+Luth99MDN?1bx`q+RdIZRCF z=TYF9HZ}X9r*vfZ=^mf|O0J{OBEU^Mb=7|K4F`uHE4To+S1xOX8H*&II*O=@y|G0t zSa21`0LOd^Jso|_r-V0sJJWgBlLpRTZ9VsVm#2~9X5(o`J9O}2=6-W*vS!#>UWq2^ z&fNm$^Z=hOHmJf~ilmMr72;`DG9X%7VoTV@kxv*+1{6j5XprHpM~|JjeaSHg zG-9`%F#f?wlnrTqUB(j-Lvj*-bINb5h0Uq{g_b_W02Njdx}UTw32H4}q*$6&th1Q6 zmG{N_;aH8sK4FV%u8sw&$DgaZM=z2w5EO|n>i$f9X#0jV{KHBkVAil)ql8zXWyYKe z+(Q?|yUpT_oKl@;cRE!1*L7o;Z~<#q|4R&GI@|13mo@bLVL0{P8O_PhqCll;Af*63 zjjFJ~ne?XUvu#%i7F%c_22B+-0`yiLI1R8|W)Zet7sW`j6lZdMN9aX0dVmXuF0Av+ zkOqlz&@p}rppX5*%K5T!&|Sy{4sZlvO*s6{I{G1As8M7ZzSagCd1AWy_Og2*>@w~_ zrmM^BpxnMgk%Uz}aNrqXtkfqkvPo3z8q3Rqjd}^urB|34I~~^@ST1i-qTs_U8Yo45 z7OB_Sw+rb=o9NK~wUI0M(EKB3k<)J1$&j7GPh7XHK4{K+CCc2mL1%Z(1^D_|DJyBe zz$8t1-?IppRE)i_UZ@b+02fjOuZZxedUb?Q!4pfAicr&%u>-6W*iLU&>=Ydi|Yz3^2 z@MTtHY36e6Jy&P`AE+G|dzQurfE?@PFaC3`@drxkLYw1+h^!ZZfz^-CAi_7xqi6DS zv;dKlY*6=Bnu;&_s8Qt)s!_6=F_7j2qI_C?!lA^nv4-8KyX#^{h#h`xHry>@H`qGw zbxXTOX_@u2h)pg?FJRgnmadt>Yc|oayLz4N8b5Ski+p%2+RwW)qKyq`6~yzBGKesF zP&kRl=OT8kXF%S#CK`dyci9it5wBeIpNhgn7_4eo=Qnq;Gz*VWrM19X*da!3XgRmi zMoUQZ38{_!p32)%fU|436!o?S=&S7JSL|$G&gC}i$miz1p?#*XUSvgA=19@uqpqic zjWe@(H9!s~!ABaQ*_nYVoB()#rvNnp#P7m&_A!*?MH=}#X zS!uQlYjnrx)u-R1ZDKtS<;iNyHW99uWYOAro6c4;O&)-jBBv8Q=OAwn0tFDMpC?sZ?b!7PqFSl#ymx!Rg*r4|JXE)Bow_dQ&PCkvBZSy(!P6-|x7(0MwknGgd~}MyTB!e5rR3P#?X1&Br;A!z%+32bOPFcO z?ozoZ286f;sFKS3tFD=+?1N2p0ch_HNa;x*L3E9CMvR%cw>@}7;5J(}zIzAyU7 zoZ~C mCSD^1DR1k6~aV=mk5?GM8*MDe6&b&os(Ok>Z>0{O!Ss=~yRcfB z%s(ecX+cKk{SegTk!y85J=X6($EE6{jgMFSloU;BV!3O$fh&&#o@v62WtV9G-}De9*a}*E6$EiNj~@Dk0c&;sc?n3=g-6?VztS=+Eifr zu)Q4YE^YjC7M&as0}-_^DnHU0$Ic4J#9k$(@YbPE?v(7&E>gvh$&dR0_ZPXo%Q{-aI9%-AXvD4j^c(*%XiUg}+%t`q<0v+6tk5N>Yhe5+up(ZeOAU$oabOor_I z;LypN8#!U>tv+ni%}anxG-;RD8GS%OX!i4IRtV-> zf+~ZVLmbhR81JZ_s%oo+=W<~h#VLCE`E2LadreHYRt9dJk&VC98o=wMI7lyG2?Lly z2aRhl$=p8_@O(c$>E=yEmIXTIE~tn;Ikuc`K8cY0(9X4jOSOyfF-oNl^8)gzeo$2W zmQMEgJx5u|M9{-r@X~bqlI+$@qok4gxCv znl)Ri!=v?D?4z>i=Y%D{*YpZ8TK2jXtvz_Y-YE5vk0zgzBn?4+_gqaXMR6178bV1b$pEL!(<>=SJ#fPhLS-NztL&er%$+ie8&$? zKGl}4n(zqw4O>eQUHXJh`!-4{GO(YlQ1V)q+fvRC7wsO4^`Uu9$8 z+XFttP^m*r(D$D|MBY6Qy|J&d*FedUW+t4{A- zf|XhWmc5ltpv4{D^xuGd(#OEy@RB@wCYPoRC#YKfND1qa8GHTfF3K&&dNn7b4Pgtl zVA_YqiPE)81t0Uq6ry5?b`A6ICl5&jJ2V!{KpKa_5lP<{8E6eXE?96RN}^S^#t?Jb zk$~i6ENJu@*~eZ-)FKbB?>hnC`b7wIebKgcsv8{elL0hv! zHWrOtvPO`h-C{(m^0>xju1{bqin+cnvy#FoE!CqHC${V{!cfY#ldzE_aYuV7;bxD% ze%c-9+&$;n!z&uS*RzvhpAVOdiv>Z=+d$0eM<#`hl3^+gZ*<>Xo@x`y92=c0`&qmA$EiXD$u$bmVz-Zan574b5I0q|Oh2<4^a;&)XX=E$C zN2V7M&(QBNPUthz4ZIBBcG0m~!_^Gl;yup198JSwp^JpWz2aPt zj@Q_Q;PWmPIKGi|wU~tz4R%Mym^^J_jSaRhgCc^_0$gCvLWYLhB_q~a)_GFK9U{d~ zp=k2q#|R4cDv*(|ft_bEmr(AWlaI--sYMzC2D$^y;w}dJ#@0Zj$WK{KE3oCUZ9(x} zI^=CpnVAD~_P1r5^Q29!efaqySIGbnzP`<;s5sK2wZQiwW-pX0CcD5Ql`-~QHQ*R3 ziIJ(RB$q$HDtnllQ>gps?SU}oF9MH_Nch;5T%nAE!j2E4#$LT;gd3(CC{&ZyIl0Sb zH;;4;3QM0iR%oDDdjaHl7vo@Hl+AEqpi*IhKCrEMsku!#Cr3ba>37toOz8LDK(P-c zD`%Y1z@oy5R#6rYbNy0X!lKAKNu%|)JzA&hC8CsY8gGpR1PLW>l!|S{6v$M1^PsolE{22r?JMHR<{{PgSP^Nh-T_vd5SVm9|oE?|x)-0g-Q#$JNRf!utS z{YB?&@{7j~FTtfBcL6jC`~n3O!PEnTKGm0J$klz?bNl+}Hs_fLOJC6V>}|J2LluM* zE?Q)JP}>eUJD{)cckhDD(f(rY@p|AMW#{sFRrYd4@$}jQ26Q(R7JP9YW8<@+TF_ zh;LW!X|&OY1fAUD3Vw_@(fbTz1YyYlYlECE$|5w3o?l8Hh05z$ZVTtWe{#NYnX)0g z!edbJcD?&yY0jDctRs4fQk7<{NN~yS97|%-9>KWQ4WyRCRw@O%5|g0@ZN1yyV{ ziJ?wDvn5vsw#v5>xw4CQ62huY-ruK{TiPgT$P6aMq1gM*Tjhl#WAl@BvEpb$JaDj9 z+llT7-@u!NYJcP~87yW{NI?)p5KjIOCBT2)zNPqMgK=|98ZPd~03 zsq=PQS$gCqs|0iLK!fIMCh0K<1Ug-OrMP%*K8a9!^tuk1lflbh`csLu`;j12`)g9M zBG+%;0oU2ZwPUwRRmJQ_#@S|TdQI zd0xp@fw8@ds_+)h6!J2ZKH)Y?g~~p`;JafL`ZPMN2AqI--GW9miH3tQV7g&evxwmU z70W6wu*?!grR^qin2XJ*e#^;7V)hVf(G+By%W&l{3JiTTzrxrb`J$rC>2A`8d>iq=Ih-!qzr{Ub zw^9f)zUd`&0UvfcZoIGd z&Tom1vI(D2+-sY^e3-<3qKQ1gtDWVURRK|zb9>_%^O#p2UEde*U}|IVS%ko0c0AE2dR(@>@~ zV-ZWgPac=c7X~aRC-c~fOgU#^{4I5xMh<1^3_aJF8_*$OZimVe`F?84%emn<{Rkz# z^VZAm3zSdV4nP%yJ!T+teJw7W&}Vfd*^swjnyhjGlk0j?!wZpmrefg^WIZ^}BvP_?aH>6DE4L0uhme$83bNiCEnXHX ze-_Kvgh^a^Jgq6*s=}kCZHlys{QgejeeM2bLjLZhTSlD1@*iR2UN~lR?;t1l#HI#k z)sOItbQxdDXOpJX&@i%y_y2^ZaBMBL^A@;#Gq^!JZ504J(zp8jtp>i1L2Bi(`Pt)q z)&9Nm5q6}$dVq`FXWQ5N%=dB+0Ta`@dOre4%tu8qGn5M4i* z$wX2%1Qr~SYkr}5Ki^q62c8n2zcKg8@``!Dlv^%#S0nNFymuZ28%dLra(`lenMFE&1<_wQ$1$cV=BwU?o+uVR+5E3ql}Kg6TiWB!e!%Btc%JNzodBhi>XT^WdEaw zsdQc@X!8YUq$-=f2D6N3eZO>jWj`HL{ma#BE!kUdV;L$!uR#fEN6PU%B&T7H%^h~W zSb0_FXK1rm6nJ#hAm-vd>L`bpVU@(k=?MJ9gQ%g*J6uAs2i)I#?+~+`MI6)3vUeLI zf-8DxYoh~%g|OuGTA=vc*V1FR%_HpLtQ5w2@@K(7=t+2E^;mRQ_4UkS{r;@T<$5p4 z`L8~5uu=DvvV98T+`|^V2v2RSI>0NLaFQm(!nIb z`xwhu?*C^n3A{uLZRz;-x?vK+5J!EbN+XG23=<~PWzk+0AVx^Lp@JoEen3~KjQkOZ zLA>#y5{n0t6~!N9d*dS5Yk&)s&+zHIRm`TgH7#yQyth(}*zk54?*+&Sjwc7&^&xgQ zrszoD+!q=lA>5zc`<;P@=vyEA<$usy3_1QB_U(O4{BzMKWcOg&UB}KxQ>FQV0ZnhZ ztL>l*aUP7(kDRjs)TqrcYV3fhv0qUKy}MZIA7`W;^N>m6tG}EoEhB#{`}BG+cCh)` z$A0OUKEM?2LJIGY=MYZBW8G4NG&iFdAW1}Z@10v=zL{8-Xr?Qj|DR!ws~Yywt8}(^g6w3a`x5y&PG8o7Mjg|TkF=%j?wXyu5TW9hz^;bP8G0zZF;j4 z?HVd)+P$nP@y1c2V;T>^ZlJtx{-dSP{~2 zCi%|R(r>XT+JZgrS+T6ilCjm|V)4Msl$z?M_&ehNf2+S={D0$a>A&|>|JUHee}DG=V1PMja5H-=DLZom(8yzaIypyg@hYwrX z=EfQs79%maSbnTpk!fIpTV;r5El9f)T;nQbT37<4hsSd!qt(xo0 zrBP;mZy*U+s-W21-N)-=-HwP2>c- zH_I$sM@-EHUkRH%ML9wD;#YWWlr@sGt(Jxq?K0Y*>CKidO9mS?o5HI)V%+(=^W&n% z-HtzE-OGTpt-1J|+ockG9;om7{tqcxZ7n@pIWO)WmwjIpEJ`^+h9(q@+3UxN5L+p| zC-#D}CutecePE+^d0KH4_`NOC4m26UXrsHPTPU+3T(z$T0X0v?>GT(c6IO?y!dxZp zHxF;*EZ@UksxVPCpwIyZ=fezM7 -quantity: {{ quantity }} -
-title: {{ title }} -
-part: {{ part }} -
-build: {{ build }} -
-
-build.reference: {{ build.reference }} -
-build.title: {{ build.title }} -
-build.status: {{ build.status }} -
-------- -
-{% for line in build.bom_items %} -reference:: {{ line.reference }} -
-quantity:: {{ line.quantity }} -
-sub_part: {{ line.sub_part }} -
-sub_part.IPN: {{ line.sub_part.IPN }} -
-sub_part.name: {{ line.sub_part.name }} -
-sub_part.build_order_allocations: {{ line.sub_part.build_order_allocations }} -
-........ -
-{% endfor %} +{% extends "report/inventree_report_base.html" %} + +{% load i18n %} +{% load report %} +{% load barcode %} +{% load inventree_extras %} +{% load markdownify %} + +{% block page_margin %} +margin: 2cm; +margin-top: 4cm; +{% endblock %} + +{% block style %} + +.header-right { + text-align: right; + float: right; +} + +.logo { + height: 20mm; + vertical-align: middle; +} + +.details { + width: 100%; + border: 1px solid; + border-radius: 3px; + padding: 5px; + min-height: 42mm; +} + +.details table { + overflow-wrap: break-word; + word-wrap: break-word; + width: 65%; + table-layout: fixed; + font-size: 75%; +} +.changes table { + overflow-wrap: break-word; + word-wrap: break-word; + width: 100%; + table-layout: fixed; + font-size: 75%; + border: 1px solid; +} + +.changes-table th { + font-size: 100%; + border: 1px solid; +} + +.changes-table td { + border: 1px solid; +} + +.details table td:not(:last-child){ + white-space: nowrap; +} + +.details table td:last-child{ + width: 50%; + padding-left: 1cm; + padding-right: 1cm; +} + +.details-table td { + padding-left: 10px; + padding-top: 5px; + padding-bottom: 5px; + border-bottom: 1px solid #555; +} + +{% endblock %} + +{% block bottom_left %} +content: "v{{report_revision}} - {{ date.isoformat }}"; +{% endblock %} + +{% block header_content %} + + + +
+

+ Build Order {{ build }} +

+
+
+ +
+{% endblock %} + +{% block page_content %} + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + {% if build.parent %} + + + + + {% endif %} + {% if build.issued_by %} + + + + + {% endif %} + {% if build.responsible %} + + + + + {% endif %} + + + + + {% if build.sub_build_count > 0 %} + + + + + {% endif %} + + + + + + + + +
{% trans "Build Order" %}{% internal_link build.get_absolute_url build %}
{% trans "Order" %}{{ reference }}
{% trans "Part" %}{% internal_link part.get_absolute_url part.IPN %}
{% trans "Quantity" %}{{ build.quantity }}
{% trans "Description" %}{{ build.title }}
{% trans "Issued" %}{% render_date build.creation_date %}
{% trans "Target Date" %} + {% if build.target_date %} + {% render_date build.target_date %} + {% else %} + Not specified + {% endif %} +
{% trans "Required For" %}{% internal_link build.parent.get_absolute_url build.parent %}
{% trans "Issued By" %}{{ build.issued_by }}
{% trans "Responsible" %}{{ build.responsible }}
{% trans "Sub builds count" %}{{ build.sub_build_count }}
{% trans "Sub Builds" %}{{ build.sub_builds }}
{% trans "Overdue" %}{{ build.is_overdue }}
{% trans "Can complete" %}{{ build.can_complete }}
+
+ +

{% trans "Notes" %}

+{% if build.notes %} +{{ build.notes|markdownify }} +{% endif %} + +

{% trans "Parts" %}

+ +
+ + + + + + + + + + {% for line in build.bom_items %} + + + + + + {% endfor %} + +
Original IPNReferenceReplace width IPN
{{ line.sub_part.IPN }} {{ line.reference }} {{ line.substitutes.all.0.part.IPN }}
+
+{% endblock %} ``` -This will result in: - -```text -reference: 0001 -quantity: 10 -title: BO0001 -part: POP-000001-001 | Converter - A to B -build: BO0001 - -build.reference: 0001 -build.title: Description of the build -build.status: 20 -------- -reference:: U002 -quantity:: 1.00000 -sub_part: ANA-000001-001 | op701 - operation amplifier -sub_part.IPN: ANA-000001-001 -sub_part.name: op701 -sub_part.build_order_allocations: ]> -........ -reference:: U001 -quantity:: 2.00000 -sub_part: ANA-000002-001 | L7805 - LDO -sub_part.IPN: ANA-000002-001 -sub_part.name: L7805 -sub_part.build_order_allocations: ]> -........ -``` {% endraw %} + +This will result a report page like this: + +{% with id="report-options", url="build/report-61.png", description="Report Example Builds" %} {% include "img.html" %} {% endwith %} + diff --git a/docs/report/context_variables.md b/docs/report/context_variables.md index 37ea702..1922d16 100644 --- a/docs/report/context_variables.md +++ b/docs/report/context_variables.md @@ -22,39 +22,6 @@ Each report has access to a number of context variables by default. The followin | request | Django request object | | user | User who made the request to render the template | -#### Build Order - -In addition to the default report context variables, the following context variables are made available to the build order report template for rendering: - -| Variable | Description | -| --- | --- | -| build | The [Build](./context_variables.md#build) object the report is being generated against | -| part | The [Part](./context_variables.md#part) object that the build references | -| reference | The build order reference string | -| quantity | Build order quantity | - -##### Build - -| Variable | Description | -| --- | --- | -| part | The [Part](./context_variables.md#part) to be built (from component BOM items) | -| reference | Build order reference (required, must be unique) | -| title | Brief title describing the build (required) | -| quantity | Number of units to be built | -| parent | Reference to a [Build](./context_variables.md#build) object for which this Build is required | -| sales_order | References to a [Sales Order](./context_variables.md#salesorder) object for which this [Build](./context_variables.md#build) is required (e.g. the output of this build will be used to fulfil a sales order) | -| take_from | [StockLocation](./context_variables.md#stocklocation) to take stock from to make this build (if blank, can take from anywhere) | -| status | Build status code | -| batch | Batch code transferred to build parts (optional) | -| creation_date | Date the build was created (auto) | -| target_date | Date the build will be overdue | -| completion_date | Date the build was completed (or, if incomplete, the expected date of completion) | -| link | External URL for extra information | -| notes | Text notes | -| completed_by | User that completed the build | -| issued_by | User that issued the build | -| responsible | User (or group) responsible for completing the build | - #### Label Certain types of labels have different context variables then other labels. @@ -128,6 +95,7 @@ Each part object has access to a lot of context variables about the part. The fo | quantity_being_built | The amount being built | | required_build_order_quantity | The amount required for build orders | | allocated_build_order_quantity | The amount allocated for build orders | +| build_order_allocations | Query set with all build order allocations for that part | | required_sales_order_quantity | The amount required for sales orders | | allocated_sales_order_quantity | The amount allocated for sales orders | | available | Wether the part is available or not |