From 49ecd70e2f5117f7ee01727d20db1cd394c54805 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul=20M=C3=BCller?= Date: Fri, 3 Apr 2015 08:17:37 +0200 Subject: [PATCH] Initial sphinx documentation. --- doc/Readme.md | 6 + .../server_client_communication.pdf | Bin doc/artwork/server_client_communication.png | Bin 0 -> 11198 bytes doc/conf.py | 314 ++++++++++++++++++ doc/description.txt | 1 + doc/index.rst | 87 +++++ examples/wrapper_example.py | 7 +- jobmanager/__init__.py | 23 ++ jobmanager/decorators.py | 2 +- setup.py | 22 +- 10 files changed, 451 insertions(+), 11 deletions(-) create mode 100644 doc/Readme.md rename doc/{ => artwork}/server_client_communication.pdf (100%) create mode 100644 doc/artwork/server_client_communication.png create mode 100644 doc/conf.py create mode 100644 doc/description.txt create mode 100644 doc/index.rst diff --git a/doc/Readme.md b/doc/Readme.md new file mode 100644 index 0000000..660e22c --- /dev/null +++ b/doc/Readme.md @@ -0,0 +1,6 @@ +#### jobmanager documentation +To compile the documentation, run + + python setup.py build_sphinx + + diff --git a/doc/server_client_communication.pdf b/doc/artwork/server_client_communication.pdf similarity index 100% rename from doc/server_client_communication.pdf rename to doc/artwork/server_client_communication.pdf diff --git a/doc/artwork/server_client_communication.png b/doc/artwork/server_client_communication.png new file mode 100644 index 0000000000000000000000000000000000000000..cef58ee3bdab652b27fd097f43a733fb73793803 GIT binary patch literal 11198 zcmZ{KbyQSe^e-&~QbPy`k^?hzONqo#Lk=a~rP5s@F~lIv&>>yY-7V76(k0y>CFSG$ zd+WWm-XHIeyLNu=*=wJB*4lfYi&R&YC%~h|LqkI&P*i|wprK&^(a_Lwai0`u+<&Ao zp9q$Xl!_D@T6GNmy&3kCjP9x-FO60)Mzi-M&|4^IsGy2z$ksJIdfriFrsR)(Q z@>)1DQgOHtcVV#+2;fna^dg4t$?^o6)8hs?3QxTtzQqbeGq1=dn6|`kXwdF65ij*wq zuWChbZ_4WQb8io>p~7`w_=MWWorOA@b4MES%8$koL?GT`Oca)Ev6okPNXVRxniNUWF zl0$(Zpo6c&1UrQeQNDdKq8DMH3^@DlS%~#VQ(BqQC?q6nxm-Riq?P8T%le7BC z>g45dE4w^H6d%jo0Tk`|tQZ29h60*NgKXC`l~hXbF6 z>%V21-b zS#i8HHjwC9C@=GX|Er?Z*f@Cj{jPiQR}#+M&3l52EAKGi{ew^QV;%Ks_vQI*!-t21 zKOW6XV_fb|k_8?2sHS!YU&jvKo5cfnUWkNA#aE@12Ww(S`PIu%ph@!LJhoVops_^K zvX_x+mLu-BJ3){`vWY!neC^jkP^&~T-_BwWk0gBK9W5i7gt0X%;$VxFhy*VUD;{{i z^`G*FhPA@c=EWJYA&8Y3#PwF&P9N{l<$5Ouq&ch>kRcWTJn4i*6*)Hota1MYpSr&X zf&4R{Vr>sRe?bj(e65HyDej+Y`eS^r5nP-isyuqqEc-*4w=g>D?t}8&}8vk3N@mo3FnYtzAjBc6_3Lq~;wC zoo5YuNzIzfgG$-o>1O|P)jN9;`mOQnyNg$PTMb}1l$xh$=k&@4=BGMBGsfO)@_8xk z6M9bOJ?1Wgi?sjoH-bn~&rXrM{Qp+1%mwy_=Gtw8HfMSiTt% zc6QNI-JFbf#Y7g|SOxbIy?KW#Z7&V3+MFLs3`|~s1m8a$HU$6dEVdyj%Jqo5SPn2p zM{fG#Da9U^kEL;vjL#k4snq=~%a+2Fa6}n!E7W^%)PS1Y+~D3dcc&grGZMk>M-lYO z4M~5yO@~Jgz-IaZ5YkaO{VTo$BSSSL45WQr2%VbGCe4=GDafZuji=au){+HW%G9Ig zS>U7~izyODOf9r>R?Yf4iFj!rmRQh&B3q^LW=EcDDYKY}_lywLwf+*fd~>2y?;CVd zh0qt(P{OfY8{vQRBjv3zmq(! zCj3LeA78EuF|5d+Y{|tYoV_#o8HE}k&S__o25o_0Wm86GuWGWc3(~^!pevu-WRM>i zTd818AAQ=(%J_oBNmS}@M&ifBycT!o8-gmGAo#jg`*K-SzwlNf_Owu%lD3}`boD@1Zy!V>w!#?rDMi9zNPGfLB0jpdG#00?9eq!>H6|&Rcx(&wvcP;z;|M)@{kS- zS*~aJd;4RG1;Z-0)T(XGRs-JICSMm6kkxau)so&2%8KFTB)Pl%v?zv;WYBUK)^>Ky)h zNagM?qb|#bh2^-Al_;L-IG{Zq49p=}pXqxuM&QAj%$YVV57@X=Dl+subL#}A4f7?| z0JNMivZCc`eS&K&DOZ`q;D9 z6b=iRR&6tO4uX_SPA*l^m1Q`ohfQbZ6OlyiOT3VLkDE*#K#m2hF452YA2_G&lZLYpOAkhgI_@z!0L7(31ibP95gN z1#K{*fv&7x%OjEDyra_fPKmRNpZd!(^f~t@;_W)>{E{ zLQJFh`OH3bmZ9mWc1nUI@U0diZJI}f;KF-6zTUl*`HJkz$8>d?0s`*iEtV{2LBiU0 zPaMz)VM?BgV=mToWvX*go50hz?nj^x)6B);juzpd&~tP`UbbNU>V3<>wASrA?9@p* z@B@~i7_#G&nDbMng2Md!>$w_d6Q5KA-puryg*Tpc_C}0kkwr4rAE(m64A}Fj1J9Le z4Vr!Cg};Q?(--M09a7+?8tZeoB@bLGdkvI9OC8>$tl@wAloKM1`|Hka%l1zvsDAY) zzkJ*{AV#)fPS#h{Yd7rR5o7V&ERRNoJhs&AZSQOtt?9$P7i%NUH|b_E zfm!LL-|8D~Bk+xn2i;bpxScto|-uWbavz7lO4P*g3Y91gJs6~u;45dPs$r^ zXMF!-4F^px!7a+Bg!J~|yL?38SKyWPJ4EmN;iKxVRP&STO#%>yG!G#gJgWI4xK~8; z_VItb#&C8Q57fkChE0yrOunLcPBnXG-n?k#y_NIw3|MF`$rl8)efE;bPvyB2^ zkyb-$@G64(zl$c1HH}ihi?6lU_kVwWN%%u4{^zNx8LCW{=QSrOf6F>i&UN$ynnsGU ztvs>EMNvK+j4^ZJ{#>nlPu^5{7#0Jhi`fd^{IlhdYzMq)d#?)5C0HLNBwRTruuEmS zaQx$Wl#9io9to}UaHngNo%p4FEPiyTm)BYq?7FNZA$ud9?f~ zCB2{ zz55&n44f_p-_ZP>UNF)BCDvsGvvcP+Hszqzueu9Ew~1w%n=4d;BFj;`TlVR|ue@(k zkNRWL8CXPY_HR;1v>lUYYB*TK1e^xXl0UoQ!|5?E5+~oGW``X@w(`WPoxij0&m{JDR$Q32>15 zs-;4!1hy%}&3~yk$dTLUQpF6SD!_hhCuVN=m~A?%|A?N0M?Op;bj4}gNC-NV8+%9S z=4+_3tjOj$_PbN{+(K*vE}heV^I2WbVOCNs*$x@YS!*S#Bng|d0Mp*&r3948g0;Bu&g$#MY-MkguDg!zMWR!6aVyYsFFCu^p5VK7D;&;d6;SOb(aPt(c z4-m%&x)k;98;+M1xG43kVdDAH!1D~gLZWe8ldXHA={;i%5@4nINzwtFjafd}%BGJH55>C*fW{Go= zYa+fZQW(`m2%_#E%FpW?$9JfY1}3p;Z!y8Qm|2KFbjmwu6r0R<$|GfK-5K1PrM`U6 zh5ihm{jKN^`B3&yETj~c21Zr2B3RmO*7On0+|V;(sY!aq#!?_fa=lpZ!O4s8n+zdk7@M27KB5ATJNpJswZSVlfiV`19H6GPw|RGc!wCUVt!4;{DY>H58z(beh_9~ z>j28RO9;X?b@V;K6XA8?g^2fqs`NU5LRdRhovs(`^tly-(D77(Xy})xq-sS=hja|~ zqjs60GM3-ysHFMx5NE7}fJxu1?@dQ9KE(sI%>i*&zmYCkWi>hFF~D}ZZ#<~tDOq{u zovK8VI57NTfhCWbz0ah{!PZ0}=scb`Emf?1^lY+oTt_sm&?`xuswyxU72CFJ!r}Y% zP3@v*1Tc|4n6h#=1vt4(!x(i>Eq)b%X;d`&Xp8##@9wR4WdP;Bq4Ekzyhxcjdk1SM zGpx=sdbc2n=#z%kt4+bU;tZ=Y2+XbRDeATNc#jM-zi_TOi=)2T?l0BdPxKCUdirsr7B)*I)m*p!e32!cwAje@Nb{Y5p}jU_XJX44Cq zl%~tDe2V8ei)M1EoyX@fXVUFI2?0TUhHA%z8TDEhUVE9Z_jH1Ycsah4fn1;nt~f?I zkZEe&u9#c77l4r`Ze2Az&-KoMlLzlNvTP}@w?DU!qfS{tMxa|m8J-)*^oFY+W!h`* zFfFVbH%x+Q9gh@qvBCBrilADpxOS!nts$7TH`bj~riFz^Yl2+s<=!h6na6^q&#G) zyg?+U8Y<>7PcJe||M^6*tp;0?$Q|ahlOe#g40;UzD0M8IR z0%0gqKXvU-EFY-nu=p*6gl|+6LSj9M1~nKTd-uHuQi~PGs1U`*UXs@2vi`FG`k$?D z@k+nixCemoq(=9hZ2-+_(CU9kOE4#IY=&BT2LB&yGKeRq&D|d2Eq^; z&S?0-8N8mMVY`%aT`yuVnZkbQ+hDpJb&Z^vWgxG>T#kxoREi!y?A}A+ibCtoh!&i! zo-2#;uS-`v3`7Ns(q_fv@$*0H{_syrHSOHi(DSjFMW#_~IwGKTGkcjZLj_qS1AX~V zm`ffhFcd$}gIY&yLM~`C-kE{q^sGW--FzGs6Un#2H=$Xhp?S^%C%b{`>M{td^xZVYXro?v8f|kqYJYwUJ`~KvPczu%3TYj+7{H&C8qyVs=^4cLbXj z!KK3!0gIVKlyIV3rQLHy9aHWaV#5K-N9Ov5bQ< z+kV~@puP;LJZ2hS6g@cPz|C$!(|oVG_^vL1;a_hH#T+$7z zYDR&(S*$1Rlptxpc`U?b@02ZAb2@dz4K-ckj>Pf%yB|drB-XO5Ed3I7!Zf7Y6uO1Fi-==^ z4X$v}#sT%+$Or2l+2Y$~u^b(eXN7M-yd41j#TWJtDm2UGNP`w82!pjL^)e+JJ;=f1 z%ZRt$G^+U1kM#uE39F>8H{54}A}~v7ft-;@;K;o?``M&JK_G@74M;agfj+oOY%N`7 zOwb3`w9d8rps8ISOP^?!xzkWyLDk>fR8(p=DH?JlZd1bxGEHGP-k4TIg_nAX+IM>t z@{stMQNVtR6()6HwA^bOW?R4neq$5!2|D{Z=soJ=mD0xjkW+_^U|+x5HnP8(t|9Sw zo*MXqni53$N;4>@ZnEYB=$U{h#5mM-M#AA6^UbRpOC1Kt+2fi`UFNvT@wyrANLua^ zzq77t86qe>AD5s|lszZ$q|Y4p&F`iO0Wip;e2VlFLs!p{VxNmytIY2kVX4tD}uRRWGNL0S{&bW~=vgcG%_A=9yi@W#} zC?Tc5Ge3Ih$?j|7_eJtEbY_nb4RX&rg842chD5Lmp;e~}>t}+o4@uEL7jIeItOVC) ziw>ZE*QOr*w~no1k95^0)Ed!CH@_PUZa0>IZoTJno)jw?2n?k;a*5gG7Xio7)!Q1m z4}Kzxxhr3st0}H%xp5h&+Vjv_0N9CDB@07h6y1=C^MlJXoQMPA3wH$RLe1?uvt7;+ zRM<}J%PESOZ#$2G>?`-HEgm4KM}_v%p-6L)I2g#Ij)iKwu9)!i4h#wConcfLY&E~l9{t-5A1rhPV7SXHlGz*Q&v~WI8>^GQ0x|B7+^qt9xs502 zuEZaN{`U9hLBj)cm$p_tUTnY_iGdd}&cJ9z0I&L?K{n(>SUWOGz6dL7+fs}TG(G*d z!M&{b=S!wnS-=_FRbEO)&D_MG5uy8|#!fr0eV1lzJyLHwn81yv?RCT*)`q4zyU>r| zd$PK@$|L4Gai>OSNSyh7kx2~DQl29UZDH&&Rg@6~zGc0r>{i_-Jgq{3ugcYzxx`)` z#zEjYhPcVCFH~8o%IDUkoF`KyiJg?MK&S5Wp0PWDkcqX6PP!-{Sp^Jw=XgYHrbmYU{O4je3Q#`1GYx2{&qV|pTVuwx7TjRXqRzsX zKCU`#mSiT;s76bq1Yl4&{U`f5l9FMZ(<9JT|HD`0WGZ7pNez`+cM?@M7~R_Va^Qm5 z_TfD}_CbU9KKLq`o)DyA*nKchBMabK4E*p9_>i8<@ndRCiCU$8DyRhE!8mwT#8B-$ z$`&C0RHY9o^?jxv%A;j!J}}8O>Cy~6YNnCE?E!EWW&#f7$?g6=ems~y%SIJ7e4ZG;>cV?V^CtBQ@0p#IgJ<2Q!BQy)%ya8`BtEl&zD-xyA*)%)Ar| zEzfF6GxsMdNCiA&7`sX|;wL>zcd}x#`=#EQh~p`UK;UGKGKL*UYJ=Bno$RIIOQ%kL z^b%(<>GJWNRQO)NE7`6{jUE*D$KZS&Qh*b4KyiQxWm7~EJ8NStk ziOs^IKCe^hD-=-b-AQ92J3^Q=7$}goKX0K|J>`I5u&dmKLo;CH?RUOq6>KD}E0g%F z02-C6^5V@boH5;4=Yr+pFZHg|A%@?I@u&X5#oGetosqe0HZ+1rxTd3QjtqotA<*s` zv64LQe)7ICaV?7}dGQv6K)lQXy8UB_#@5xfi_mtG>R@E3)N`?Hi@9oUxKs+bJUm4e z&&p;lM|}VO3j0r*((W#Uw3(ZbuR$jw)=5SaLluTlnTWAvt@F$ZU5@UK8@4BZUOfy< z12QjEgnrRQHDU9-T-67LMJ}>YnkR#JK)Y~%Ax60QACVAZr)WcmQq$OAe=`W2Hs>=8 zn%l=El3REeaW1k);sXh?Yr`&peu|}^c&dT3exIWYNG^gd3h^k=lR!ZlK^A_oC#MRi zo28v=zU6kXX-V!&`(%td1xeVcTUg+sJ~RjM`(1mE$Y60P9Kto@z?Rp>OSk4n$54kL zQo$Y*kc)eNsj|=?nY1>X4lY_aAM)>u_*YdD#E=A%)?oayrPLD!MmbsNDF$f#(Da_y zLocSA?l+!Yg}P;kijFYsIRcMV@&`%x8CeTs>&TA}HaLHoW6gWv%OmgA)v9>GX06)X z(AAnG@=RWZWg)gY%#_60wQgcI1H~`Wg{$XCeoO4xf}#2~OmB)Jpkvha(s=1%{N z1+8xSu(!c*b1rIK)4ps3xnH0GNvWIR5EQ!$B_^!>gXjaR`?aoFPpIf&>s z&TaHhzp+4GQa~n4-D?3{G6C5NXR3zO{;=4SUiA$pIpuoFnic7YGJjc3 zR)8N+RZ(wX{LY(9u)4_)?Y?yPsNFf)AE*GPE#|Mncr67cJsB7HQpjMC64KO{L`Paj zb9z=>(^Ds(>ToskX&4^Ra;g~wHZQb*-7M)J56+i$!OinH#yES1YW7V7`LhvWHCQ6D67&W`>yg7)&K zgu^^8k_WUu<3JA+gs-sEz=+R2sYbTGgS?D1Z`GE@7}Z2YLE!Ey>Se4eqg+2i{Q;J! z_GF;ASO`h?M%%*2IaOgZu1t9T^NRE(Ls1lXtA@pFJFYrafjw9{H{Vw7Y25JM12wlo zaNF%D(}~5$xu6K}*PxF#MKvk=hezjYQfVG+t<-1J4!m2EfC=oy-BA-dNSWg|=SX3~ zgBDVjURKoOntK~oMbze)VEpBqlSST^jSJWpgAFTAnk3;Fu>?Y&(ieoe%In#NM{GX9 zrJsCckfVfs!Sv971TiCRIMq95LWMuc;O~1fbh~jS?!PcA)e=}*HUcF&>FWCH zN&ePlTX@Q`a#M>#_Y$LhK_4cMw7_D;WvS;XN4H5&SguK^+B;+8Wo~V7?{E~#3s>$i zV&(_;W7;z$pc!4JwRh$LIPz>v2u9OMB@sAEd-KQ#$-u#T)rw~^wfUco|AYmG3e!6s z`F+)5)|5ugNES^87Ejb&;)A???VvYlBIT$VX!}q($4v{kiTuw;7?0QduF?y%_sv<(I?<;0M80BQ?OIZBU=u z_aXo8b+@j1)Bw>r-=AR%qfP`qVQm_4G_MT);8k{z{JgT|flEh&k!XEt1BtCW!>yu# z?nn#D3hpy|5(GBWTcUwKr8aoV_LC7d`;;+_Xm{YROCRr+%H(StJ+Ky zOdaz+f=L{d9+7$+F`Qo%$@N`;k2y%fxU%;+GY{*_HpET=8I#P)FxK^B z*z_?a2fF9n`x2K6)JJ?~7%lp&x3E(UKt1s_SP41oJ=U6aFolo_R5JcIH_2A@${HDp?J4kNn#Iq22D?R-=n z2C1R0GY#l;x6>A;?`sO9A+Rc}xF)v-a5Xp1-2{D$cX~(WN#);b{Bz+F5wV;RH^c2E zNVTB*4P=5C)hAJJ4&RuwCG#}{!>>^Ep4yjLKpR@3ycNF1u=k(Ngl|QiBY2`DP}is` z8BG*9cQIbQDiwFDzGle5)iJr#`L(A~}FnA)0ZsInO=NXgqSKe49DpXKL?^QZvH zRBgci9eN>^iomCRn!J0o^rbAI2Z}x3G^04c1{`K9n~HK>7X#N4I}s;^y>>xpqPjjo zV8{sXd6Ub%0!sJQJyss=9C!8~VSvGwr83la-I6SAj@_p0e z_6SqQcuOkUjf;ra>UTRDlD70AUihM1Rotnz%_3i_oZJPeg#>cAzQg!|98RZQ{PHdc z%P6HuU%fX%!}mGp&^tI_<(uK!&_FRUZj3a66?7TL0^U#hi!?ae2EEx z2jR|=m#HW(KMtu@?j7^1K%EVk^;WF&X{`uS`Mkj(s^=o9srQO&9-{G`qag1lzKPsMG;2mUY+pRmtHcEGPw$wF)dlL z9{2Me;$FgDn-BehqOaC(L*Z)7;o8N6{AqQ_sW&WzShLr9dz=N(e~82(4VZucX)V?T zaN>`8fgC{S4AIPelI`xVH;NJ;2gABxAB zkm}mZm*(+es*EJqkmd7k<9cPf|s&P zM-?PFKBY9UEg}BS`Yj0f1$a;Q$lMq9_WoftXVub@hgXB5Mdx3+Y;Rz~P+l6#RVS`4 zm{HZbV$NirQiQYnM9#>4VRPT+v4(P~`^kiZ_X2~V6LdQ{4nMC0EpQktZ$tOK(#JD! zmE3M$7I5ro=AnaJ-dH!Q>bJ6%Y5Ac{G41uyg?Aq#*To7HA{c<1((vs_jVkg29^2BARYSc! zDwwXCs+9LDj}nEG-vS~wfEHM!9XEwjhf2CuriEe#cSs5HGpq?UUDQAr1HQ|d zWOM;QTMbZB?{Pk{3n&`dbVyY+*`AIRiw538+|`I#{D+6OX;d#zRe4?s`O3s`l`@rG zuk|Kn^&Cpbf^x{uvDTlLW|_I08C_=g-D|6bNANKMi*be|1e;Uus1?)_Wp~X1oU&{n zxcbj<^Fgf(13c^_7`JAicn0gO@>EVEA(v$UYS28T1|^KmpwG!4omDlg+`3c-M3uy< z77lX=_?QBd<|tLL)dScTtF1QfCVq^<@XEvsC?E{!kx@HVUVZB7N3ew&)th}>S*fz7Zr z2&9mOF|DK0OO03=6|R}n97DY1(qyC4Ey`=OTAr>;56>{89e3mB20PiyuSI44ke=0Zce#P-TPaOe4+i?wf=MIK+bSf-yoVb}r7b0L zPTie1(6SVe>8`4u)hk#Dd+AM&?z|rYB%USA7OI!29rl6sk1pHRsiWkIe-6hvYkoy* zJ^VF+_>`*^w(!gO-)BRUN;R60VRt)=Ywuh|f)9U(y_?_i1}2l*I5IP*{?S@vy%(Oz z$4P?h1l7EC=8;hQq!!*=yQaaTWo3lppItH<@+9Dxx#qRp5=g;jKZ=rRB zAgqoRXmyq_X7aB_`L*D#f0%4Qs$jFt#FnQYPeE?7x^9+cZdRfeE>=$jjgN;{kdsG% zlZRi6M_80sKvY1Gorh19hlfr@>(&1Quy?e4Z|(j62RINP<~{*f|69Sy(ppsEy@r*m zw4=L&<$DJkX-6+KL4F=C0YNW5A$~4l5g~RSb{=XhmiZ?L+5ds)Sh={qcXU8ghstsC XatYF78{&&R+0hhbRiPEqra}J;$eafq literal 0 HcmV?d00001 diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..20645d4 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,314 @@ +# -*- coding: utf-8 -*- +# +# project documentation build configuration file, created by +# sphinx-quickstart on Sat Feb 22 09:35:49 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + + +sys.path.insert(0, os.path.abspath(os.path.join(os.path.abspath( + os.path.dirname(__file__)), '../'))) + +sys.path.append(os.path.abspath('_extensions')) + +# include examples + +sys.path.append(os.path.abspath(os.path.dirname(__file__)+"/../examples")) + + +# There should be a file "setup.py" that has the property "version" +from setup import author, authors, description, name, version, year +projectname = name +projectdescription = description + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +#extensions = [ +# 'sphinx.ext.autodoc', +# 'sphinx.ext.doctest', +# 'sphinx.ext.coverage', +# 'sphinx.ext.pngmath', +# 'sphinx.ext.viewcode', +#] + + +extensions = [ +# 'matplotlib.sphinxext.mathmpl', +# 'matplotlib.sphinxext.only_directives', +# 'matplotlib.sphinxext.plot_directive', +# 'ipython_directive', + 'sphinx.ext.intersphinx', + 'sphinx.ext.autodoc', +# 'sphinx.ext.doctest', +# 'ipython_console_highlighting', +# 'sphinx.ext.pngmath', + 'sphinx.ext.mathjax', +# 'sphinx.ext.todo', +# 'inheritance_diagram', +# 'hidden_code_block', + 'sphinx.ext.autosummary', +# 'sphinx.ext.viewcode', + 'numpydoc', + ] + + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = projectname +copyright = year+", "+author + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +#pygments_style = 'default' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = {"stickysidebar": True} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# 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". +#html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = projectname+'doc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', projectname+'.tex', projectname+' Documentation', + author, 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', projectname, projectname+' Documentation', + authors, 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', projectname, projectname+u' Documentation', + author, projectname, + projectdescription, + 'Numeric'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +# ----------------------------------------------------------------------------- +# intersphinx +# ----------------------------------------------------------------------------- +_python_doc_base = 'http://docs.python.org/2.7' +intersphinx_mapping = { + _python_doc_base: None, + 'http://docs.scipy.org/doc/numpy': None, + 'http://docs.scipy.org/doc/scipy/reference': None, +} + diff --git a/doc/description.txt b/doc/description.txt new file mode 100644 index 0000000..378d0f7 --- /dev/null +++ b/doc/description.txt @@ -0,0 +1 @@ +Easy distributed computing based on the python class SyncManager for remote communication and python module multiprocessing for local parallelism. diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..c41eabc --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,87 @@ +jobmanager documentation +======================== + + +Content +------- +.. toctree:: + :maxdepth: 4 + + index + +For an alphabetically sorted list of all modules, classes, and +methods, see :ref:`genindex`. + + +Main module +----------- +.. automodule:: jobmanager + + +Progress monitoring +------------------- +.. automodule:: jobmanager.progress + :members: + + +User Convenience +----------------- +Decorators +~~~~~~~~~~ +.. automodule:: jobmanager.decorators + :members: + + +ODE wrapper +~~~~~~~~~~~ +.. automodule:: jobmanager.ode_wrapper + :members: + + +Core modules +------------ +jobmanager +~~~~~~~~~~ +clients +~~~~~~~ +.. automodule:: jobmanager.jobmanager + :members: + +clients +~~~~~~~ +.. automodule:: jobmanager.clients + :members: + + +servers +~~~~~~~ +.. automodule:: jobmanager.servers + :members: + + +persistentData +~~~~~~~~~~~~~~ +.. automodule:: jobmanager.persistentData + :members: + + + +Examples +-------- + +simple example +~~~~~~~~~~~~~~ +.. automodule:: simple_example +Download: :download:`../examples/simple_example.py`. + +.. literalinclude:: ../examples/simple_example.py + + +decorators +~~~~~~~~~~ +.. automodule:: wrapper_example +Download: :download:`../examples/wrapper_example.py`. + +.. literalinclude:: ../examples/wrapper_example.py + + diff --git a/examples/wrapper_example.py b/examples/wrapper_example.py index 7e7dd45..02bcb04 100644 --- a/examples/wrapper_example.py +++ b/examples/wrapper_example.py @@ -1,8 +1,11 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- -""" How to wrap or decorate a function with a progress bar. -""" from __future__ import division, print_function +""" How to wrap or decorate a function with a progress bar. + + +""" + from os.path import split, dirname, abspath import sys diff --git a/jobmanager/__init__.py b/jobmanager/__init__.py index 91da553..d2e072f 100644 --- a/jobmanager/__init__.py +++ b/jobmanager/__init__.py @@ -1,5 +1,28 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- +""" +.. include:: ../doc/description.txt + +.. currentmodule:: jobmanager.jobmanager + +Scheduling across different processes/machines is implemented in the +core modules :mod:`jobmanager.jobmanager`, :mod:`jobmanager.servers`, +and :mod:`jobmanager.clients`. + +.. autosummary:: + JobManager_Client + JobManager_Server + +.. figure:: ../doc/artwork/server_client_communication.png + :align: center + + +Progress classes are implemented in the :mod:`jobmanager.progress` +submodule. Intuitive access to progress bars is facilitated with +decorators (:mod:`jobmanager.decorators`). + +""" + import warnings from .jm_version import __version__ diff --git a/jobmanager/decorators.py b/jobmanager/decorators.py index 8eea309..b5b22f3 100644 --- a/jobmanager/decorators.py +++ b/jobmanager/decorators.py @@ -10,7 +10,7 @@ import warnings from . import progress from .jobmanager import getCountKwargs, validCountKwargs -__all__ = ["ProgressBar", "ProgressBarOverrideCount"] +#__all__ = ["ProgressBar", "ProgressBarOverrideCount"] class ProgressBar(object): diff --git a/setup.py b/setup.py index b353591..beec754 100644 --- a/setup.py +++ b/setup.py @@ -1,11 +1,20 @@ #!/usr/bin/env python +# -*- coding: utf-8 -*- # To create a distribution package for pip or easy-install: # python setup.py sdist from setuptools import setup, find_packages, Command from os.path import join, dirname, realpath from warnings import warn -name='jobmanager' +author = u"Richard Hartmann" +authors = [author, u"Paul Müller"] +name = 'jobmanager' +description = 'Python job manager for parallel computing.' +year = "2015" + +DIR = realpath(dirname(__file__)) + +longdescription = open(join(DIR, "doc/description.txt"), "r").read().strip() class PyTest(Command): user_options = [] @@ -33,18 +42,15 @@ except: setup( name=name, - author='Richard Hartmann', - #author_email='richard.hartmann...', + author=author, + authors=authors, url='https://github.com/cimatosa/jobmanager', version=version, packages=[name], package_dir={name: name}, license="MIT", - description='Python job manager for parallel computing.', - long_description="""easy distributed computing based on the python -class SyncManager for remote communication -and python module multiprocessing for local -parallelism.""", + description=description, + long_description=longdescription, install_requires=["sqlitedict>=1.2.0", "NumPy>=1.5.1"], tests_require=["psutil"], keywords=["multiprocessing", "queue", "parallel", "distributed", "computing",