From 651fe13a12d5216f55d787f8cfdbc1032836595b Mon Sep 17 00:00:00 2001 From: qth2hi Date: Thu, 10 Feb 2022 09:12:39 +0100 Subject: [PATCH 1/4] - Predefined the name of output file (.tex/.pdf file of Sphinx and LaTeX output) --- doc/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index d9775b34..75c607a6 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -51,7 +51,8 @@ # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# Bosch specific addons: +# -- Options for TEX/PDF output ------------------------------------------------- + # Redefinition of text boxes (using LaTeX package 'tcolorbox' instead of the Sphinx internal 'sphinxlightbox' and 'sphinxheavybox') latex_additional_files = ["latex_addons/sphinxlatexadmonitions.sty"] # The original installation version of this file can be found here: @@ -59,6 +60,8 @@ # The latex_addons folder contains this file with the same name! # Reason: Because of too much dependencies and adaptions the complete file has to be exchanged! +latex_documents = [('index', 'Json-Preprocessor.tex', project, author, 'manual', False)] + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # From 8c73bfc6d888e9931e43ed415346956752c22cfa Mon Sep 17 00:00:00 2001 From: qth2hi Date: Thu, 10 Feb 2022 09:18:40 +0100 Subject: [PATCH 2/4] - Provided renamed PDF file --- ...preprocessor.pdf => Json-Preprocessor.pdf} | Bin 302524 -> 302525 bytes 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/_build/latex/{thejsonpreprocessor.pdf => Json-Preprocessor.pdf} (98%) diff --git a/doc/_build/latex/thejsonpreprocessor.pdf b/doc/_build/latex/Json-Preprocessor.pdf similarity index 98% rename from doc/_build/latex/thejsonpreprocessor.pdf rename to doc/_build/latex/Json-Preprocessor.pdf index 282eaf273bc897e6cb173b2059f402678c8f670f..8c7b93d1b4721a996e19525249a921188b592fb0 100644 GIT binary patch delta 3979 zcmai0ZD^Kd6mI!i@{+a|24b_9iOgx{eeUn$hTuN5(ipW7Cczl`CRWqbrB=`rT3CM0 z7CaV;hG9h?6U!2`!u(Ot4++sfnNX4xh(#jyP3LL8bI&=0#>U{>_j%5BuKPOIeIGqi z^U0B#1M&7M*MIDehNRpF?Z;L13s?TyG_mKU!)uo|ZkzYwqSpO&O{GJ%rLmoL$EHm9 z?a#wdQ?vW*$)7Gh)4uVSabvEG{^#Vt`j_jf;|=rPdiVXk6E}Zb_1(_%Gxq-a>H43` zj}G?I?JLa!F{qVx__luTHZ8+BS>P_F=d$4X?%V*W+S6?`? z`S&l+JhAEASG)e6G-LMsp0*Bu^M{MV1N#o2TDBlr`Nq*hM?04e9PkaN-@JHv#hJPL zUmKWk_qzVElP`^4d3nc^Q=h%={+*qj#q#nct9w_KyL*Zox@tFe)mG8p_4GIDKlqP?_05?wY#@mn%X)`D^0(ZE$Jhh3p*QpNo7B!<)vcwA9Rd% zgqZhf{gy)gc$?p@(S-=<;w^>75te+==?B>oiYyP1j@nw7bsH$LW@Ah{wo;mwOJLJ| z*^(1WMu+rLwq(STwkmDeMoU2~0X5b?@{)=wJ(n%X4=NQ>vz^dufu6vdbi;N^6X!2|jGFA)VY;XsilpS6^Xql~0fN73ve-W{imPyE?Faim-!-1yqax>LaR{CxvpU zg~3=-kp-zr8OB4Vv?z+8F`@|C$U3H6Z-Ey^LYRvsq)0@u5fq?A9b|VAL@ZN3V^Goe zECa10nqZO~8bv|pISW*R#wVMdp&_CVI>7=cW7+i3K5sdL00ZD?%~L8KhX0jX>}$Hz9;1T2aJt`e~bYj2U7pIBq2X8aQZBXhjWF#7uVn*JuUE zc+G>+s3^)}G$fV@4!}5m#uPJJ0yH?pbaK@c!C1pkYow4!cGe9gS8|<>ygM*~I|qO> z$moZqK<>&40|X~Fg7ZV7sb~g5Py!$ZFTkKnzka1~Yl7DruVBZZm_CVc9XR2rf$Ny= z5wd@NFyt&O26QFCe}_efU9lSyNe~hPM1ft?urM&7O%QU@1~pfNwg!e1o{0^#b(%?x zVmOF!I6y-eU%or)MDq!!+~5R2OIvwvfJA6flRI!ZX{S8%D$rio62$^{2a+s#M!v8{ zqj2zulVSAxz@42w7$vQqMlJtA+D9hIV?hC9Rg=r*B}@DRNz1bj5^ASdGVP08m=yCy z7B-T>5Ue=5Xs}%dy=Uqt$JJgIK~6R8bLozL8Y&Qs#|S9;i6clX3R|S1a#6y>5n$rr zzT8k{Udc~}?sXw2RC3TzNkvfG0t~tw;e$g(e#}WTiYADGF`ykgeJ~Kj=^ITq2G2!$ zDTtU!4DZ-_6L?|ky|Btav&)MF@Rg_0kX1#Cj!$!RaFv;BL!|+tXI4NHpt;>>dcAYc zrxQlwYdKp;_a^Tcwc$rco~A2ryrCCtW+TW%NHHHcKy;D4LWvcUhbZhdpL*J7 zSaV61?D)k>vA`b>n(o@XArhnX>f;w?7LylnFvBOTcUAYY$IGjVO-<>{-G#fF+Yno+ tduVO(b1gPU-KuOe0?cXlp{1>DcByI3|7=P3>@JKSV~SIzw6)JI{tH7`S0Vra delta 3963 zcmai1eQ1?s6z8rt7#Ad67*?BJoHExCpL3pXzhXKw16}5#54GHKY+)Lf5>oVnnNjK- zB)vkc{3FOR$fB5{7EzRajQ;3DP%sx|Ur-r=VF;af*Xh0I3>v#!IOlnubI$Ml&hL5d zu_JXykJKFu^);rHEk9bAk#_eFE&EW7-}c9o&&@koxADYp@BdS~e8=(EYNzy{oLm~$ zG4+G#@y`o~pssG-Q183{4)snrT^N38_~wgUH??f7X+JaZwgU~D8c#Kh@7r>^=Ckqj zPt01`IO(pQhBMF3yYH>vr>Hv(&DWf(oin-p*#6@ujt+d4 z_G~=0q~nG2KQ(W@IQP{h^<75}?)mbuZ&%%Y=h=Iw?eExrb$9WhmOVc{IO)RE>g5&R zt^Q*1@W(4|xc}_;=X=lH)BE|0uWz~iz~)Bt*UEuUex0@K(={_^e$#yG8%z7f9e(`c zje`>opIukzI@G+q|L3iTE*ziz_LMsYJ609DH>`bh(<9xT>x}*I*t#45g99kV(6f`N-)Lfjk^x?H_otwH#GumdOLi!(FlJ)FJ_BPv+%Ku6mO2zye zFa$G(&Dm_m&ZKFgu3nDO`k=D4JCiwMxSWUVo!k|~E(a=0b|tf~Q&IR#@L9($+6K}E zI(sE|8R63CvcGc|3K!~_we^w92^Uadd&YJtAG05Fmpo7@mzmv^J&5d02$*f#P1{8F zCLm;A=PrSV@y2D-`ja^Ym#yhf9w^xCqyD5R+2P zanlN#D>~4yJTXM=S&d|~j@f9hi#%yiR@4njn~HhK0EB0Cpyg1N4nBO?4fcK6lBM1jEUaI6uAqbIk0Z@CvExG|Pdwy>+AvGE}jRON?t&|Y zjEE3MP4jofSkBscuI6-LkWji11u`y*xkpckRmZ>xDGJuoLdOoItgT|339Z1%NH(WA z24? zYl9$RpsQ8xmFuEPp@IzMzSGSv$VD#&RteDHOMXNgBZ!solRTFZtPmlswB>;{4Fux? zXz+pynqIMdj7h`=F-c!_Rl&r6y7;x{fsJ!QI%zt^Yq5OCE{sYo^3E-c## Date: Thu, 10 Feb 2022 09:24:45 +0100 Subject: [PATCH 3/4] - Adaptions in README.rst (mail addresses, pdf file name) --- README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 53f84a4f..90fe6082 100644 --- a/README.rst +++ b/README.rst @@ -42,13 +42,13 @@ package documentation is located in 'doc/_build/'. Package Documentation --------------------- -A detailed documentation of the Json Preprocessor's Package can be found here: `thejsonpreprocessor.pdf `_ +A detailed documentation of the Json Preprocessor's Package can be found here: `Json-Preprocessor.pdf `_ Feedback -------- -To give us a feedback, you can send an email to `Thomas Pollerspöck `_ +To give us a feedback, you can send an email to `Thomas Pollerspöck `_ In case you want to report a bug or request any interesting feature, please don't hesitate to raise a ticket. @@ -56,14 +56,14 @@ hesitate to raise a ticket. Maintainers ----------- -`Thomas Pollerspöck `_ +`Thomas Pollerspöck `_ Contributors ------------ -`Mai Dinh Nam Son `_ +`Mai Dinh Nam Son `_ -`Tran Duy Ngoan `_ +`Tran Duy Ngoan `_ License ------- From cd4d5762f5c9d8514ba49fcacbbdc5cda9512622 Mon Sep 17 00:00:00 2001 From: qth2hi Date: Thu, 10 Feb 2022 10:38:11 +0100 Subject: [PATCH 4/4] - fixed some typing issues in feature_documentation.rst --- doc/_build/latex/Json-Preprocessor.pdf | Bin 302525 -> 302525 bytes doc/additional_doc/feature_documentation.rst | 12 ++++++------ 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/_build/latex/Json-Preprocessor.pdf b/doc/_build/latex/Json-Preprocessor.pdf index 8c7b93d1b4721a996e19525249a921188b592fb0..18fbe515de894c29c80a307e8ec5af03f1300f19 100644 GIT binary patch delta 2441 zcmai#c{tPy7svg^WSB07(jEIu*~@JfV+>=P8AGx}$a2YgMM^Q<+aSZGh!Q1}LiQ{r z`!Hj0?b+A5k~G;emdKWO(0lKF|Lgwop68tBJkRI*eV%j9Ux&+)=5nN?s)6cO0L8Rx z05qBJTLC;n3Xz-C)f#$iC)3BvS6+W`xuyY>xhzzAx zgz}Pp2|?vYerWt@y|=nQ;g2(QA$Bu9E@^c1S5(-I4R6}ULcEaw60GxCbL=r?LI3qg z+8SVh9z1UVuRvXKV!wIE^AH*srH5|_q-yQG_Fga^=@(wzuiVL z>SVmV4aT;Cprq^Z<<0O}^U}Bbcf1BSo}V$YIqx^-;y_s!tX{BP`uT?ga6uc)l=w-j zJOS#hSFJJMCp66aXjG-Jl?)h=L6NZcyfi)Q^-n|A(eOOOM`VS|Ni4?{-w_Wh)7Ylk zcB2#3+AFHN7t)%C&$TZ4`zrYb^NCr;X^iPWF}I(U^)uk5yWA!%ulPrww{!0G`brfT z7O%lf$DX#4qctv0td{ZtmEM%N82Lt|9?MOB@(o0y#m>RXZ_`bO$qi1LdiPt<{qBLL zwt%rX;hK|O68L2zpW~S)t^zs?V~eR={@uPVT1Ld?1zofs1|-v9hhS|n!eXlmj4!0f z&eYBY~TvC*1GbMB>*15WDc-Sxd%SmLW{Z5fwzDG>RTZ%kgh zou-5h)&(9>f4^AwTQ>^R3IUUgPT1F<-gL~pD_(CyxOl6@t-uAUnk{0A;QuI4#SiEO zho#kiri2^XYY0*K#U)!%jR6pXz0B2 ziX?A&qw#g+_-aCBNkrk2l-#`{2~0_5eJLmB$d?C|gBVSRsN z%XBki|ED{Bvw_lAGQqnk-uj29>EzW$E1!{!SF{}0HbSiA#vdhL#rg_F8 z5qL=6`U0jz+Wm~s#Oyic*}CC1T7=f_R#vU7`$;46%7I?wsIArK6^XiW!HeP2pxk${ zIf1O!@*22NTFn_thGkVQTUJ*rMY+hwdLZ|%orlfHu9jtrQj@l<%Cyq@BC<69@wGWe z)q|p~53(-84kryatGnSu=Z-0@8V15L=YQn_{b!TVP_kQK9l53apys4x3wN}G@#Q8I z`W|?u7!?04BIozgl}+Qm0yCFT!iq-uKyyE$Cm?hCCF{~L#t$7eV(~c3#E`P6BPVjM zb)Eg`jLDO+44R!wI146}{-h6->==}PCcH4LrRAy0h}y*_jthRj@IYyxm;2xV$>M#f81LMLswFjTopHR0Ut>{_v}XOu^Zqw?)@B zUC)mTonoa@PcVGh#f>4bLvHfC*rR~HqWyWhkn2L-D|Y9L8D1Bo4YWL~X8MAo$8{gu z%vo=h3u}ifdG8}V>-(wOCUXi7^Uswo*t~wCw)Vl(@#>#uGgG4R5Kzc1ZTJdc2{p4t zWniLI+ZaT6q|=Pny>OEJ>(g5*j8(e&$W$}5`^WauNvX`zuYucE$bxCEv_d+uqXNt!Rg?o+gW666}c>}#hTFJac zVozYeXtereviRvk$%unJU8{QP_f}IpbK~IkgA4YXJTdKor=D)PVY-&H}j% z{$<&qa!V;F)6IVl-w^nDqGEEiI$YBE3gz3Z3A?ic_hI?;EB>}>f@mG9z6=cyBhqXk zTM)+^vh_OKYSQ6m1l?`5QJDl4oN-skJwEZxFT1%iA&5<5(Y={fCT|%y#B%EaOr-&x zfBq_~V-ipSGoCGHP@AY_!o z?4C);jVbNp8IsK}fv#ckBBrZ6WK+*vK(I|a=tGu1TE&0=E;^DSJRW*I{-49*I3Iz( z3dG`k6pksZzv%LwS-9gW802w3KBDp=hP_q{~G>!Sa~a0JZv3{N1SzGnnH zN{2~%2=+15`%c23@q~YEK_L8V6b4N|5txV5z=;5sm7NCWijb)&T^%!$9)&k%0Ax;=~GsPr@A75a>?Jk5;RN_6e z9~YYC{cJQ8ToD z3cN13FAwy9`20$sfv6QsOM-}?O+vHq+`0by<>DyYSm$K?&zfQ7x?LsBrPrhw6)9Ja zQBO~%Z1p3qax0TYUUgb_ziFpi#v&Lmh7_MXwLXhSd2PiqT-xMOQ>#QRPM5BItm3Rr zei?z4EbcNqJmWD0E<@UB$%ayi7eni@jg@kug!`pA-HY{9$l8Vy+<6YwRDaU!R zXq|k0=?N8Xy*;t@;df7e;W!dfC95ht8Kk$qs8oBB{;cC^hl<dr=cI~n zJYJ5UKbQH*mwz5FnYevUnm!2rZA-%i`Xf=(QX5C**|K@J0?BBd{rLx_V$7B73xGu%pB2PG4g(YIQ1 z#ywdlsW(FkdB#-iFYCEZrKfApy?MO(@j`UQ!~7l|T6ouS$<^J+?3zEE#fz+i8@9Gm z4@+OqHsS<-sg%(%jXQ#T+O3<#C;8}mjma-%)&|0x+;bl|%LL0qc=6RgHqblh1GRNm zVB?E-Yz_*%tke_EGJ2CzDg}tti&bfA#r7T3C6)sNsv{_~$g2Asj>23=S8Q(%qORC& z{qfw(MvqMQ_onZqMm=&h&obM@R;x|Pxf7klZ5-k zSwZzDOv@}8ZJKo+CeH0=wtdCyr!5d4{%ow$Fji@3!3f9`JsG4F&n~Jr$DqahHv67S z<<1WTxaph!A|~BiY26*p-C5Xl+g!E^8Q`CZOB&r*BIZFrHS;Z|16S+q8*4sA%qEph z(uBj5P0wM5qk-|uTZ^`%dZhRwmYG$`spE9OX}ugyzPybMl2488txV=+1P^mOxCp_4 z6PNprI^*rZg%{pKbJ8veHad?+6-;bN;7A~$kRo$ua?(*+S% z#m9Mb4^q0v`H5nklNVH&Jc=-J92ink+12A$2{f*Ojw+u8LR#zn3~}`>1?myIbN| zqdvooqBG#Mm395b=%f@(d2jkc`u452La;L}ZQFh)v0~3kDf49pZc4m11aq%9Pn9C+ z^@nBqHc=3vd3)t*FL0ypC#&D`c{r!Ht*vF-RVke<3i5K0b{TKvBsf#~R)H@*K+NIB zpO=u^yiRwGjRY)@Ejk|mkq#ROw`T9muo#lA8 z*_H7hhRkEdx>?a*_Yrn8$q&~xRn|So1zuyO0#W4M{bL04M!Ap6!Y_|1G}7cMWVeb4 zY1VV(mSW5HudOG-Yja^^CkM^ww;IoohA#c_=irx%cB5auv<_ANwp>4|zJXVybxtv+ zJ_YD5{b!dKH|_12l>7pqC!|4?tTsCnW!YtNC#dvY$V9iOrrV^P(}WTAY(``}Seu`H z4SMZ&?KO@SM&WsjUsMl&t^8d3NHMFWK@PO)7o*4Ar;tvx*}UygBM6luYg3-5hfUpi zyy3evYHsSYR@NN$f<_!zvGQ$I*imOMX{nDe>rM2_R~?iUkYSOh{gIz9eJGF>d9ZbQ zKuStJ0S$K1`R5PC_eTKJU$q^{?`GID%OItCuO84*MRxK}5QF;m*C2fegZ*$!zRF&G zqP6hc+!GINi?QB5Z>)U*m)sO|HroF{YCANv4I4ox+_AtYsqA2p1odt zJ-rYCgr8gVg2Q&VGCF5UR=SIPXhpub1Fp8pnnz0?2+pfG5p5fTMM zB4Gy7CQe~zNq$iQP&mmPjYR+5DCGYv^+73+PH~Va8_9y40O9JHEJ%>V4|pi@pMr)$ zrT^I|6wVC5u(vZIFc<9i5`e>^|HaGz)9)D$08rmE0EaYVM`c0$t$^<&Gztg&>k0t) zR}>lrppb0kY)A?SQ(u$~X_g=!B?AD-48WpDM64|au)(8ANQ@1DLLIfi;)rCjHPrI| LS=dGQAew&xMru<2 diff --git a/doc/additional_doc/feature_documentation.rst b/doc/additional_doc/feature_documentation.rst index 711a3465..62a4def3 100644 --- a/doc/additional_doc/feature_documentation.rst +++ b/doc/additional_doc/feature_documentation.rst @@ -235,9 +235,9 @@ parameters. User can update parameters which are already declared and add new pa or new element into existing parameters. The below example will show the way to do these features. -In case we have many different variants, and each varaint requires a different value -assigned to the parameter. This feature could help us update new value for existen -parameters, it also supports to add new parameters to existen configuation object. +In case we have many different variants, and each variant requires a different value +assigned to the parameter. This feature could help us update new value for existing +parameters, it also supports to add new parameters to existing configuation object. **Example:** @@ -407,10 +407,10 @@ The ``config.json`` file is handled by JsonPreprocessor package, then return the Feedback -------- -To give us a feedback, you can send an email to `Thomas Pollerspöck `_ or -`RBVH-ECM-Automation_Test_Framework-Associates `_ +To give us a feedback, you can send an email to `Thomas Pollerspöck `_ or +`RBVH-ECM-Automation_Test_Framework-Associates `_ -In case you want to report a bug or request any interesting feature, please don't hesitate to rasie a ticket on +In case you want to report a bug or request any interesting feature, please don't hesitate to raise a ticket on `our Jira `_ References