From 37f200d884badc65528e7cc8c19bf02ab0427035 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Fri, 19 Aug 2011 15:00:55 -0400 Subject: [PATCH] Removed pyramid logo from the documentation, started adding the setting options to the documentation --- docs/_static/pyramid.png | Bin 21085 -> 0 bytes docs/conf.py | 2 +- docs/index.rst | 1 + docs/settings.rst | 268 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 270 insertions(+), 1 deletion(-) delete mode 100644 docs/_static/pyramid.png create mode 100644 docs/settings.rst diff --git a/docs/_static/pyramid.png b/docs/_static/pyramid.png deleted file mode 100644 index 78c76902b72f67535d32a502129d20493e90ecf0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 21085 zcmV*cKvTboP)002)21^@s6Y~9X!00001b5ch_0Itp) z=>Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2iph} z5gIep=%;o703ZNKL_t(|+U&h&xMW9l@BLp@JMYeY@;P(nOwf!*qmeWUh%5mHgE1Ho z7$E}!6D*9tBolnWn8!AcEt_O6SPsHiM3IcZLIR9HC?Zf!BTb$;xpVi(@qN{-1Vt?e4w1>es7k)ml{>IH40dp+~PSdE5& zLHv;I+IKgb^=lS(o_hC_pZT(*|NQ%}`jg+3<@sGay={-)d-nM!0Q`B@>tA^R{_@JN z{%^})d-2OA)869grAm2E6vodV^mCgP-hc6tgukBS?dU6=WXFv)wPcjS!5iCn^#gSC2)uE-}?OV6t8Bcj4 z)>qfi?sX|IGK^1-p;W2x;?X49?hVNKh zsrY0VCaU!YSW2)0r0qii*fKrF&wu*kNJt6N1%jXtm_7$VN)W)2qsK7nciAv3fE5K% zf?VgAnVki}M7P&dn>Nj^uC}^2_k!g8Z+YKG_C1!{!uWXv@T*_H9suy%=RUO}(&VC7 z|I(9wAx-lOxX6*`3WNR#k^)$^fx2(=Sj~rR8z@zqkfuutnpK`7(?Fi46pw~1tRXZs zs*a>qZ=}1OcB+fms#QEOw|NYXTY@14yN*HK6%z^)?ez|-wbc+dTR-VH}66ab}otm@MI+!!3kXV>~^UlBNwK&q?bD zTeofIsri$r*X<&R5?)zZrOw(4jvqY+!!*#Cn)e^;ZSZpqU=)mUou>oGu&R}s!=C5R z_;?+L?Q)@+iY(_*7=b|)^m@p$99fofQGg1S!;k{L=dh51STVwA1dap#;XmX;7_hf( z*^X9gjoa-OGXxzta*U@YC$MF9oNQAdh!a|Gt+H*|SlB#Ab2Br%di*G#9`=OUU|7qQ7$*<;FN~UFkLELF~Da%qMVMK%8fVE*l=>nD|As}Ix0*=Xm z%HbOdmSe&6DyZZY-nMNk{lb&ZLK+S@Q%vo4kJ2ROR;SCuFdZkt%7rg4XPXPE>(IvnBQe6J2s}QGI?z&~A zRe{lPgfxi}h9RObLcxI63Z{^dOpwxmW!Z2{8_}SRC`~aoF@ed2Z7@s=nt@z_T))cW z;}c|0PY?v5$a0o~soxvm{s$hy;iXj^B|@j$hhYjNafq z(eJciNE4eDHd9U(?s<3(DLJr84T9-Gm@eWZMrZvvh5c3J$q2sZ!*P9z;}DHz9cP@j z8?zG)8V-60hkeu?iJEVdtqLse--m;bJcv9==;+ZUgo7?hmOTGN7yKC3m7o0Bv!cOZ zP8ABiYrzs449zM{DNZ#?o)6!%_{h;EI<`7OYj^;TDL5E~G%NrOLYBpxL@`x;8+Ffs zB?b3~5ve>u91LOEHpgK=0u09@-1ejU`1)IZLT`Kh1=xM^xlr2VO%n}juPW~o=mXJc zfH;ZZx@C+_G%-0ffw{Rh2E%}}qM$(A>ksT-`YHe%U;Q37O+DiTfR8mj_32Of*6N`H zD-hPS22kWVNRCjj#9FMdg$b@_qgwH>uw@Eo?cIaz3lnH{+n8(*kwg(j?G{)XxNqOX z*s?H#G2cPZ7idmRAr2Xf>qGL&C3a1V3}NB4(@)`D3%AnB;xa~^E@T7HP=Hl}S1QA+ zHIU~y1}PV2?kNE1+}Ar{0Ut}M0vG_e``$ysmzoSC1Bj6&F+fD6l7l^)C(x{Ua9x}B zp0*2T>^%cJwr#?Z{rhPD1N-3A8W?n2fCfp^gfv_XMiI8m&C=@PaRku-K@j8GYro5z zwr-=H+qZCOei~c0Y@$mqeI?R3LR1JKNJvV8Ooy;d1EduU0xV%r$th(3;QGLISAQAL z{*{-U0PxYM?M>i7=l^;APeInhM;5)Qig2oB7lIU2o+D2}_FX}{cFaQQ0-6jybMIdA zT@%Ch3c_KZ3kFGPz;rwqR*91&Cg1a*3PwSa-AbJp8uObcQSyBp-1iW4kt^SG#mq#V zcAc^lL=uBRA3-o+DFr!x1*s}PD9AAd9FwLSW5y`}mUlk!#sA{>{N%dNK{!>MdHye- z0Pts3fBuEPz>R-*4SoJg-{5}+pZwIv|KJIZWb>BW?`aH%!%I{e)+Fa(RiG$x2txu| zLlp{^l3oWh6-gF&Ls!ABW>tkYyRh#!6V&ya|SBV`6$1DvepQ z#z{L)#;v#AjD7nal0g{b^gX+=_mmv~F-+SAw2w3nk%mLSuwhs(rEGA}>64Sozqsp$ zuf3;Ut?o;6YiZ{>Pw4=_G%eB0c^C1WfBbBm`L63u0Qj?}SH0|4@P?QD1_1EKzkHQ* z+uwcu@tyV7o+qAj&bb!xukGLW5Qd!<2q6IpE(!%`CMgVYbMjO^{Ct4nstX)4J%dcTIMYe-|&Tptn%2m zX3u=)*MWCFCfe#ToelFFuYJYVWZ3<*QpGuw6O+!C*$Iq#E!=b81Db?@>v;r#(lmiq z%%*7&NkSMz*mK%mH0m`tlwfwEf&2C!!{S;GIa{zS17R>i9E>m;4dMGf&N|~XUf487 z5*lF`!m=zLpBU$QsZ7H`AB9qs7Q{E+avPN^WjyogPlQ7XK@h>RB=R(YN)zNNgXdLP zm?n`ldA-%=<16c8c6tVlMipdQ!LV@7d)5WNe&@~C{H=V_b1zmWCZc~v)n8xyo%NNa zr}&oR?A^6hwH6N)_dU3eEzcFU;|Rqdt--wUKcqN{IgTRUv2zzsPfv252JCw_-*)>? z_(wmvm%IId2i*eVs-zw^|)qU0xeK^6+1OO zO2K(n64~JG0Pv*eUaYSD+NW>=z@H&~=(67f09^n5Yb)JO=Na?!+i=$2Q~81W?vneD zt{4RuNYezG0hMPcvJ6rXga8cFqHWuDVaG{ZNhL$7xh8q8h4ogKOv9o|wNAOpV7O({ z%w+i`vda|+2!wHhI8LB6)b!L8EX(2EpkK-hWrktOz2OMN3Q`Eko==rZ4N5VRXh?B11hM9+u?Ef0G-a9>vOOF@tKy=&e(>cN1HhDPh$}Du zApQLpKaOj^`sjo4F);>w``g}#4}JI(8^`b50Pw>f{J=}MZrizV=4mJ6;DHBme5K89 zxeQh0NaBnkBn&|yk^nRh!wwdumJBTP>;Q7)HIq&Yi&2|xJ3 z&1h6>IRE^o^3tJ$h{8V7JVU9{;5ZsWWh1zyDj1rlCdVM9MGx&iTx{ArX9R=(djNc8 z?{i+M|8;$Q`^%Rj5;k6V!K+UI`2VN=^s*1)&L7`GANueo_+OXp-hKLcJLV^_x_A(+ z^)6i312e!(kS0Mu!?J7$)5M_D!Svi_?Ao;h{Z0!d*F>e_BMnDbT3SPtD42$Za7-9( z8Cq$S{0gLLz?2e&>v9~$$l{15=V#a}mta~Z7UU+RX@Z$e^VIJ2*e|&>zj=Xgxbb#q z)`$l~eC;cLhkB!iQ+Mvd;*kVJmVu>2rO`wdMM#qnu>`zQ1C6@RdvXkB;OC_$=8VJ&q;vl3vD@dsVhYua1aE?Vsl=Xtipv*;N*OJ6c7t2O!D$DK=3GU8Dm6E&BiG#xm69PLOW$cUwB5{e9hHP|pY zO>;_u5z=r7GHjlho2TizgKe8<;5iPbNks7|Ky9pnG|gFQMcd|QQ7xBY`#u+iqFgB) zKC*(pz2Z}xs+3CADqivOU*kQycF^HR?uX73HZ6lBNhDE#I89JMBFmXQ&nKn9>%9>S zLsFqM3T9ZQi9w3*T=I?&{vxokg98zruz>&B`q+nmAMgF$jinO*R*oNqV_Oi= zxc9#Mar5o>LJJ$V;~`HI3_ESaX#%p#DA$`Cxq@y9PN|G=G(-}GDEkgr7ud0VJAB_k z5Cn*#1jE4qN)>2#x>#9Xhb}VoyIpizE!=zmgK%sUgCM~J`}UFRSUf#B1tEyiBx6Yg ztqVvgVVNeR0m=)-w(U~A=2MjA00c7$YPb7{h6B9j&2ReBSH5y}FhA+gH?H~K2`~6R zTX)@g=TDDE{lP1eB$v&x2|WJnQ=!u?-}IxOaAy!wo@QL+1y~qRDn~HvV>B3Xk*09H z3P0t%^HHz)w6=TzzIgq6~#1q-g@v5Nt^U!Klw#V{z-i6nrm?Py&EeP|KI~}+p)T`_E*jEDdS1! zo`zuk2;Xq??G$Dp+ms*yl7>O1VGvjmD<&Z&8jW!}>zs4ox~2{~Eixp?v@FWflysWV z+8`#sF-5LlCSpy@Aj>V0(ghVoK_mnjj!Q&DDox3@OxnG3EA7}iPg^(7Q(h?25ahTv zkpUv1$hIspO@oLvRjV}`YmQO1QlW<)K1l6On@Z&pX(A*^!o$Ik7Pf4r`MFI9!hoVA zrb1~_g(j^Povv z8L*rZE6pT?gk{^XEt@UNAp*ckA&W*#%rrGUiR}w>D3?4oEt^KeA<`_v{M^jOrG*86 zVHpNjt5wn}1CikVD8`+4-$N1%kVH{vX<$AA3MjnLX9uiYb6`ZNZ{!XVgf8s-b0{-nnVk+t~S-@5_*K|+pg zLfR(Vjt2=smZwA{8N?7m;*8VJfM*FZRnGI%bsgsgnWimt7U1~OD&KQ(g;Kaowg({u zv{Iz=j0prO2vUNIB;_y|B8(zbYvUvhgEvjraPFC>Vs5fYX`FDY+e4lylzf*IGdrFO z*Kr{YgIvdjfr4$%rlX5(+rA^Zy-%#o}Jr7FTdy|D0wd5ch?;# zvJ|Fe5TMzy3@`|a4a%~dbFBzuAWDit7}8j8b+KdT4lo((M~^QpPEJi8wLJGXpZC&B zSKspbU&b%J_+mWkSuZ(Z0skZY#wD-D$3AvB0N`~OzxX{-zjp-*dO@1R=dn_|o_O}@ zWet$ycx0Ledtw}fQRqWoqi+1cd2~(3}G#rKK z_1X|h(elz77MB*WeaA^OHa1R!evgz^5JHe7K>(8~axf7w3y{j$vW0MbACB$lwe@w1 z!?4tDcc<4|tzA)?=GT4i*6-bR$0IoB{cR_lkpG?j;C;UhrxODJ-g@b4o;K?B zJ~-(2s#02oW!m|W* z+G|vH9cBX*rx}k%0sr{!dujjC)*zE zKJsZZT0is=fOmS8T5h|pdD^b6vhK0C;l>-W-VMl*CbU*WBw&~(@+<`bC{zxufs;+w4 zn3E*t*_jy;#|dS5hG7_@wZ4v8y#_F#mB!NAI=bC9wr|~nMx%)^3Q^=aq+vk_0oDar zYd{##T0;;3Xbc8J7^Xv}X;8WBkrZUMR@U{k*WdaN-@D;fJpQyPy!|b2z@=|~BmVsI zPvNfH{{esTS6BZ0hT`7#jyRe{rGYJ5wqa&w21OFUCXGtP$0!U?_Nxd6eGG;H zSlF;U6OLgaO=E;X7oJy!Rj$Ia9pp)ZIF6vShU0lCl!jqCaBT-!)I&HLB297>c>#vR z^vo>MEWscMv18{+SZlR83PaSJbsC?ahh;lxcRHw6${39LFl`HSn`W`Pwoa2%GkEZ! zLs;wdVA>8wxk8erxclx0;W-Xo_Of3^sa(VUhwej~L@-Tb7FnU}ltT zf>Wx(aD5a-3Y9ZDgWx$B-~Bs8^l#F*Zn^Q6pU+tEyWjOzEFVAoQ~3V5Y}b7cv<8ZT z&pP8&nw#)&@q1~!n7QaVD>$i9LIz0`w-G(cpf#W4k-}6&R|HBt7U^sX54k>Jph4U^1>I_;7K9L7 zXb`l9loH9P%aau!YeuV|c>3XJE2k;(Dco zLW9=UTAZdi%GC-QwJN1qhLZ1bp2T1QGE5Vu6bvCr8V=i*MXRf;{CC%UhaSBDeh3Dl zG-H#P1Q&=34bQXryz`zy&wkD?V%TZn$ie+wtNN5>3d|bNnl*@W-dMK`*37J^-WUgy zp;y}-v9PcOV9LssQdIJ*(eirto_h}*dBYpt{Jx_fx$K>I>pL&|`LTdcc*dEy^?MtU zjj%VkJd47M0|+>di=xPoL;-f6yq!1C)NtEPKfuF>mf<)qJC=!D6_5a=Bu=6bL>ihI z)k>YVZ{5zUax^Lx-n3~345B@ZS2e##~?R&_JjSY!R%j5zQnPzyE3I^RSg9uVc_@y$DVPV+ovnEa5ew%x}9_g70 zUhi}vgrwQ&adi75Hcb!JvP-sWvgc_E20b9i@$a|*)|#c4{0?ULpA zqyW+&(wfPuHOX>)O46Kkkx>?nh*d!|vy-%GcA9#fwi<;211wz2gkLU`W!rFViV#35CxWdewPe8;`yTSV1rnR2CR zFpO#c{zDW;0ZmMd(`2(rqhX)4)+7x{U`<+SG7L!?OnFvNl4jiLwrG63Nm~}SaTKQ* z3`f*zb#xSt$g=I77ryGkE5G*DZ^fVg%MapZFMlb%^p$Tuwk=?1Z3Q3s_!SBO(kyvL znxsalHU`%(!LV%Jb@EBHeXfSvZn~Zh9$G=Q-UN~2JTHhOkY@>`5Nx>)2|@6@674?q zbhx(E>2QdW?+&$Al{ATE5SeV477c=wrR7o59U)CqI3=51*QZ=5n2v)yiP(01s!z;p zh{O zR4e5gm;j|U3`4*vRbbm5bP*#>a~RTsG!3vcQ6v$PID%>`u!fStgezU zE%qH3X&xhrB6#+OBXsj^_u`v>e+?`XAZ8@0K)K|>5)#t1Ff%)i7yrt00hM88@i2t6 zVA~Rw00yHNFl{KMAPoa~kt2>G%r9&Q3>PFoN-_7l9ZHobl-oGt!k1t2z`t&{&;RX5 z#YGptML%jS;H%&8dNgcUNb>@Q>!4Kj zfg(pZ=phJ)@XJ+Y4>3K*sVoyO?(+dR-YJjW+#80d~7?spe4 zF+L7WL{l>poW?n2NyN|!W6cJnVWHO>VL0qVF)#`uc#Z>tfKos&3{fc&?z;N{n1;l~ zFMk<4*Twz=4iUB6Z!lntMfO+{H*MIKo zI?sCy(K))j)>TgFp$lL3hV~ae^Kp9FE8fJ9Iso7HmRF&8}E}w0R45Z=0f}#Upt5;1XP~4BK%5Xt=HeK^v)6Bn`yz z2#)38ls%^bAoN-*+^o1Lv_h{xLmEip2qn)$IP9ajFvU}In`k&3pil+U zU_icK;y8*(6*)_3L7F~UUKvFivlK)n--9JLCXiL3NeBVMut-V?&5S{}1887!yoRc8 zV`YJ&iCQ_E`Ifb7h-;48;%}11ZmmuTnj4CQDhlN2$+tA zG*gJ91ZJ*KAjWdL&!!|6M92&EDW8f@Ez(i%k?!>>0`s*S@d zRY8^o+b;t|Y}pp7)hetr+U1%n} z==smVruofSJbn~;mSJOxiUAOa0AX85kVBdTQxK+`4Gh8&t*)&@7^YrbU1!EI;W!oz z2LWQm7yRYrANcs|FM0pIvmbi!(bWaN;+4mD3q>RVp)}GYWD+JZN$fstFVD?S(_rm5 zPgER~eT#x1;jwCsyt0e6uQtrHXR3i7d~!$TRZ%3Z!9UX=R10Wrq$QJB}g`F)`NUJkyk` z9Nl&cXYM_XlQf~VwH6FPa4gAbT2L5`;Cc=~#8EV&G#;T9FN3AYS`Z0hluKnSg(;_5 zLNhbd*tUHeX6I*EE21Muj)4GJro&;J5Qre9iSJ&26W8k%dgjxgj`j5x;&8waf=tsw zUMNV`%&f_@O$fsTF}UJOB6tXs6iS2AT#L!^DtEelgmF?NSuq*)qu&7V*5Cc3%kiV@ zu0W|Wj<7KCxTiknXL}mv-g_ST>G9cTo%vqPe0G{=a4R)9woP#y@%*NFdeWJvqP2RE z{^9#KAc``QQb6;@x(3^}iCH5}Mqpt;2%=MVor;sTFVLvH&aP#V=a)!BbGO$gzvM$w zfjfSD2OfC%Ajq_6(CwkUvWB84ki;<=mV@fp7)q5oNPr5R!!DKKSDWxFb%HcuSuOxZ zo+VUmjDbnQvK&~ZO$OAgB0tXE{z7m z4KLEN(I1Y;G6b59Dw3qY!6V1Wacu0`wG)nIAqWC;JP&D>!8C0UG^wHh6eCG<9?lGA83di<_ac6|0HcRtYj>(71zpS0wcUW(6r?y7&ARQmomFRUL~et{GQ8WS@tg`g-5FgZ4c$L(3*)x}3} z`|Wq5UEn9hZb{fM@izXXBNmJ(g53gWus%ieC zcg&7uqdyElAlQ!0hH0ZQ=A$`1gHaH$;dro|5{AJ5S*F->%21l2AyE_s=Y>KVCy2rx ze6PZ`TLGhh$`#@)<1C5MXw={@EMU+d@b;6o<8f#0fdz#mi8&i@;0S31!2s3rDctW3 zkfb>T<>+@hJRBt$Mk&osPeE(uQ53;*Ty)#3Xg0@qG#sJPXh18*VA$u1?;{8!OwP<8 zgvI+0Eh8Sa00InYux%UAO2M=QTI(JD>es%B$;mN1{;V@0gyc9JpjN4(KkUOZO=d6@ z6dY5aAjx^2!*?ZSCL74LX45b+IoU+BQ5Tl&Ac;nJ!sPVDm;d!uzxz*Zy5&i)0RZf~ z^{ZHEhj`laUise(;Je>>DUKiB|L>MX{rJ5^a#9M3JdP;J6=r8=_?%O>Am|*&9e3Ub zNE^0L5JDnXDT=&+WjauKhBQr)7X_vp4J<5dg33a8w&WnrDCk5qJ<&j;T0*PaW1WTA z|L_s4bq27j4a89bVOj7hRV2AW7^f&3DUx6am8Kg{K&sTBNkSJH(l`W2z;+!t-V~sC zBg;e(lqwL0eYmy*2nnSLrsbf>GYono%uY5jK0bypNf1XdCdS9GxU__JXC3|C5Y<{4 z(lV)1GZBUZHS9^fb^A6miDC>#BUVL$V@Hp{a!g2L9*%9p8Xtq>I!Ft~9e3V|Oq)oV z5k(P9o8ej}eAh%2B`AslW6e6WR=E1=YtZk7*tTsRj#q|38kRMNes=&(4BIrIG@!vC zX+TPWiIR)XFu?;4K8!8%vsACuc;~hSD)I!m=6B!u-M{&zlIyfh(_GiWTwd&^SDgHW z3-v_kakkD2TAu>LN-qq|BUV1zDDhB+nsW^4QcY2{1GSJio-kFeuFu2qF|k z#-=IAc09O_56wBJaY6<$1Q@x>xmu}{?|O)m1Vx^48b`FcvIf^QzHWd~a%z*<9V zMRB&Vv%<+!6BMU86B#Iq45XW6*_I3j1H@?tB2Ak&&v6_^WV;Sb!+;WsEz2ee!tUL> z(5%<^u6rM(M!kWcy^JV~ILiw%ga-`)A&3b~<&ux3j#Ux1 z*0|7$@YCG4mmI6`X>;Lx!}c%?F#w!M+lXIPMuND2T%FinDGnFQAGTo;yM zpjxew6bAAvgDy1kG$sLpDhlLzjyMb`2}2}lf^ZZ<5GWY-QLk0esFkp~w$5e0M4m0l zwoD45gqN4sC>TX#KybCvq&&~q5CV>E3Dak{E`pbu}Eu1 zuiJ(1IdEK;{IbvGQW-%oL=cA1nuxT<#iQGLG>SM4h3%2b* znik?wgrGP0N8kz+X^J#WkR~ybBn2^Jefc+mNJEh4dDy;fGgZqz%}ms>?WCQwZ{L0xQnOd`0nNyZ45mR~ zCIn%O;c$eRnMusgZ$_3Rl%)~8lFw0;1FRth!Ib6(gn0p7D43=|lIB=hZ^QF!uKe+_`Y@Qi2Trkge{ zJU27(2Zpeo41zXYUzDpA9u9{X3`45d>wNwb&LmTXbjxkGQa?z@HY8<9Oodh?gdp2C z2t-t5Ihlr}YOO&#cAi4Dl0zy@uw(mH>h}9wDS0&BtkB9@hl41A6hwF3c{lDqc$}76 zJ?alel%)lwNlsx9Q7{TftBm3#r6`Fgi6aV!14^SIg~5Q<*VidcQZhZCglUjrS!8)7 zvMr0^ctoX2ogg-n5~__c@=F!6Er;?vp)d@{cO9yfJOV2O!$30;7n+6Vdni|YZCMs7 z)rx2~DlEw$+bff8+vxQA5T;3!V@-;akd7WdMroGO`uZ9V`*s>1Ymk@I3gX3YdUiuM5-lAuI=_Y8BPS7_vNr=lY<3Om83cR^hlMxaA5= z+eOJQfe7G2AxUz8m~@u1Wg4{Oqy^5i9BG=8==Ng02#$qVe3ak`X*IQ_Jx@6fN>a{ADJsVO8N|KC(lq{u$ zApz4gKqQc+2|VA0Yr9C26saPB0aI@DRECro8?P75=6FLFY3ItT{{E)Fx$MoAsmYSP zdi*et5~wd<{aqY6dJrG|=%4-PB_q7?jW4H9eB!eV0GIvoN5&Qxk5p|-dU+ncGmXQS z+l~iP3Ls)8z%&f(*gSKtTaylpt(KVg z0Uj`Bu)A%l=c?-Jn%{f(-SLcjTKRE17-B~WGRFL1{o3c;qr3On_q%)THGSK&N0#QW zZ42jGco6`N=G0ec|KoYKAQj_8VrV< zWhtif6{OY}^!wD+D-P_jy|;(y;UOloC7GaDia`A$MlbKP(rfmvt5*;4{N?9yaInw6 z{|BF-4}JLKR4vvtbO1q6KpZKU)_@5hA>f@yk|gw1|L`l#1NYt~iY!ql(-VZ?*gFr2 zwK}#zU|Cg2vt&JQ&cZl_&Ux(b??bBy-qjSRNl-Ep(|PH&l26`pYJYO=#!Vz?GA%~8 zeeX-Y^!3mEwW{Fndh1){PyW<TX+4RP@RIBMX*Q?oE1@kMlAXsO4 zHkn{PTTo!&#b-{Vp9K8rC;t?)Weu$a;v`3u#9#)bkO^AM{Zq zF>c%2f>wZ(5lIOYdFs+w(x9J5Ra4W|%a?Ke>Jcwm2Zlo1bO<3JOEW}i4@zmwPbOF` z7LddU!9z%eB=3PpAV~{w2;kt+>kUyi70T5DN@=JhM;sR*VzkB}QZYynq?G6v1t8tuzf9sLo1c2ZD;4k6l-}@_{9{_*+ z$9^2|c;|m)0C@2|xBaKCZQt0Gvs+FkhnrnfCc*j;ry1I2NykSwscKr>fA^iZ)98p#j1OkN+ zV48-CA|(b<*E$FU0zBpY0ZC$r;3+sqH!eR%4^U?V#gQbfHCs<~ zwbeu4{w?47;a~ja|8eOJUvV#f<<~#-`KjR7yzCBq^ph9y zLqGHbuRb}t@dy#+<#NJp=P1hxCNOEG(9|V6Yw^H+XK;FNgeT9P!_yZoK`99c0Wd)- z0oz$9E#QoUw+2a?VQ+sQ8=JdO+#w+c5v3@Klx`lKV1IX;ZP#LRYXki}qGzAIfG3_l z&s}G5V>$zg1UiYq6d+^<6~)N145oEx+YbHV0Cm#>?9uNJ5S+!y;Ssv7#c(u6Q?5W# zB8n3PYoL=9ZChitSb|6*iU?W~iv9>fNX%ywc*j_+Y7$!Vs~@_bUi*p%AXUOuRZ|*C zPV)@&#T?^}4PB^aqc@)Fn1HN2ux!oiWH#0oySy z-tFx(@zVQWgjg#q=5usy2O z3;#bI(Qo_L{|uE`KtJWoY21RxOWm|gG`{JNIa8P9dKqDUt=b=&RO*xF*()O4`jgY^MbYj`r9 z!m&UU2?*$rrtY0!igOIomZmf}dE3>M4z zf|-cw*&Kl#tnHXd&|)!#j$%YwbKAB=V3fx%gp}MYc;lgE5hdJj(Mp7rZ zaPbJAdh{_K6d7qHuqq9Dd7lx3PVEmdn>U!xEB@psKTX4aftTEW7Qq_k5U8~QiUeXU z*&9b809s2Bn3YmA9>i!&fRqvU^PKWD!D6|B6pF32bo%ruzIyE%OjnJmJ*xlZtB$531GgrtTY+!q%C!Trw3H;vge~in>fS1w(|`#<=||6T##T6W8aycaf3 zdT34a@+6KCMKQF}1QHDLFkL_hgtK?vire>kIQRHtIQPT_BuNiiMvy{5D~UxphgLC! z5Rh7;E^FL%<{sRA_i0Ryj*uyW6&a={GZ@EcjYSqKjCwuRDkcWObq#l|MKKt1=K_*E z#cDQ(P7|bQiX@GZ4R#P`DV#N6mTp#oM5lP{@$^YQm3j#nANU{t^lLdNt1Y>^js{km3;HYg@ zzH9uRB=NmBuik)A3SDb)csO|}fPefsjgU@9m>o~>ufFNcud?31pP(P~o?h0~<;$wF z+y%hSI2dEl)hpEH3SC{{j$8L}YIlIkm!8F+oqGn>Sg;R}N`bwDR03K_c;~>@!a9qC zQ>XFL2OmIN&vE(kl@}<=EWCGM0E>AEAp~wc*a8IOnP)HH#`P1-OM_xK1cX{sR7iz1 zEf8k~l6(M?8ckK9Z7Ku~h?5l7ImAhhBq`v%fwcxoMyMAHIOh;2DNNIVC;(DJ#VMTk z5CEi9u%<&*F3~g<2mwi&!gMvYO~bd{x=;6?y#o(Dc$W6I$0%0|Fgp}^LV1=zz;i!O zDK82@XcSontu(wfSS?lv-a`sTk@et=Mb*@R4~VsfARvxYNFk8t8Me1ac+p*VfK&vf zB>Md!m;{v4&`M!)G{IukAapHm9L;h0%2oKTLY5{-l!7&G{pVxA`+%nNkdpAs`O7#t zIl*W=Mt{&lp2cv+p?zVm9_jV|od{4;LTUv;faw~{mo*lv2G$vjMm?++bM$&c8ji;z zNmFj>isrK!h#8%=kb>{|#((nWtDm(3e%;r8H9qibzqzi{t?M7niws&3mM1fGU4u05 zgPGx73)5LLUCmO)xa;%*?mo4N=gvQg$3A@yL<(`D5v&FA+T+kP&3g6G3MP2$@7;o1 zZaF|zu27eARP_={MKG*VtRr+O92kBu7OY*K6oT~hTsk2G(wVS$V?%M z5_s=XH!XUDA*2L^Adret^atG4B?kQwYoSrDS_}p=;>c;~RSu?5rCNV6OP0T2=au@O%0J6oHu)`NYwE)%c;)8z_UGQf-^ z%MisKhW$P?Nlc~_fC8d8Lp5811*0f3xTeL0i_gKchu|7%tS~ulP*xqXEI}G8L`j5R ze}HDb4*BUghVsBO&tAmd&IXF!m*QY+h$QO3l)^g$>ljMv^-AaijI{u0of*_wtQv!s z8GFel4tl51cAh)q2mtNw?QvjF<$MKr%cG5LS}x2_eHH-IydVJlrmuU$8}eTNm0Bw- zX2&eF#;`x8Bu%*MYO>BkDFvNu;I2DvrTgyK!_!ZG8jnA5fwQbn!~x6+saZ~%^{-lL?%)aK_QI&s+jYi8M~w2TRsDTp1i1JdOh?81&UPjVp-D3bcV9* zkR+PpQ`WxB&=LX>)1EJyOwpV2|j>=XDKB)YmucI z-aBTQ(0o=S-A$1d5t`Ply(1J+nxshga&Fs}0*KShCZ7es_r33z832kr{~GVQq-~cV zsVM6W5GOGU=MbcVPYRHbxP5;I58SzrtCuh0i6@?dRvDrwLerE$5bFp=6rr&m8o+X~ zz-V(9_uv0wdyZ`1qfE3Wf>Gs)Y*)bgtKi zLZl$07&?g%%LwsCADyx2S_e%YDiUBx>#|C3VXa3n0sXu{S=F#@1F2(lO#^FMq*)FY z3RPKRGMT-gnj`d!9C556q(oWPfM=|#Ib0wFZ;)ph27>__7tpj8N-`H&0c9c)M={3Z z0Y`C+YgeveS+8K7gAfvlk{|&L@&c>n0zv});RsdNA#oXYwzeQuikp)urt|f&pZ!4} z1OgL727zIbpg$a7auun-ANeqvwuPU}ASeJr zKneu`3lb8G(&FQP_^0R<8D96gS0h1ysB5&|L1+c3)H+`>*5s^bup?^>@+_jNZh3OF zBxZ}f-93(@h?;f+O*$Jgt!Rqh5{8oMH&b!a7s{t0~i6OSPT0g@hdxm<_02v8)! zM92~i+qD>vxA5{;yd1G+Eawv}R}1JkL)#kk^Ay_~J={2&qB*iSwZ8#p8hrGRKY?eS zJA_P9FbniXV=w??JCITkh%uekh_wUA!h42u4oV0JDd2;JlnUON^?fN2#|gU5!P)>H zI#lHf%mI2)!vknd2ivw#S|S($(;6Hf9-(OrNHCZQ!B_~TsBK!#6OFD}5xX40H6S>8 z?&3vsUB@7%<*KDLOE^nn%oj@z03;DDmMhxX8NmwTlao0)Z)v%x*@ZyQJ$H>S_Af(4 z8mqEG-8%T-prdqMV}t+#!8+h%=}=WItSyno8duAk>!^|>3`ae7p2;>XBB_z2DQ1&7 z=K!@fpeVBSQDfEs0f>_rvssA`|K5i&-W=oXnKS4@4d-g4IzwGG2*IOBQvifD4Gj^I zq&QZj>N?a_g~`c`k~l@xG^o24iB{l1eB7y1z{?zI_|luRceg`1IotB7$ItwkpYck2p>c zT!*r2i2<;8$cr9c^0Jo_fpB~@fpZ?4;{i2w1Md{FEQN|S{qduZ;*+0#9{>F7zZ$#a zm=0$p;=Bi?6)HD^8P=L~q#3ZFd*H%ap1?O5KvCf^#iv&>;u}UTF?(Jf4 zXOB0>WAytYhENnG7F$YEV2eS&Mp?Bq9QEMYV>+F4+Zq;OHGCNxRv>Jlt!fEiJwD9>UnmnCdlBON4^B^pJq z&uz7W3yww`W47&zQcWyWSf{}tpkJg=Qc~MlfHk_#;@3a$Thx4&#e?^sL7c>B$`!#o zR#L%uCMgvnAz`gSQ#FuUVmRo9<+7yN#EUr3d9f^sNFeI>asB#Ds+tCEXR$0RsO9|T zPaDT$B0?I+F+8Iw=O8H&>j(rxi`ksLUzhcP7`xlM^rF*yJfGa8XP&tTXB|WcFR%y@ zl+qZF$M9x}$z+PUwg5#qd-h&HFpiFou(y$6QCb)a6lsh|M<`Ow-c&@PhW8y;^Fv&z z6?M)d(vkz#U@^f!DTyLWP`3`67)h2O&0}aC!+Q&F1EM5?={h934<9@@1gJDYlJ?>4 zdPClI262>v1R#k}RW%4P6ul6&5r81E-Wo`Pj$;T&SZk5yDU{O0Lb4JHS_o2Fac4S| ziv=8jcre7y<``Nj+&r3M(92O|IlMK*0o)qPEF_&wr`XvZlTtFYjSV`Ia&vQl>7s=9 zjP1=$Y;A3ztZH1ndW2pcBTHitX|!#Pago8ewLzwIgnQ54&5f}%8gJlaGDTT6bZ~GB zw#XU8Xx$;Z*Uw-e91!((Hw+wIU^y7 zowM8pLs_06B1!BeASEj;RU8fdbiNASTXC?rgXOZu-u@OJA5AGAzo6=gc*S3Pu=wnj14&5|Rfaptyts8G|nC!Xf%VhLtmr@csp zD2{l!s7UG_9(>?FoWA`Oj|MsI?Cj#;)U6=)JV+JgafCd}5u9Zy1#ORdoTr)y9?QDo z$;pcDIei;lxp9N*rbVn3#agiQjKD-`vd&D2;*6s>C6WS>Qt;lf5Jc-*VnSfYT5A$Y zBaI`(I(mUB1M7@ofTJWPsU)fDkAq3($ zrOmA|pSop-cXs#0VzH!1D*yuXWyyJ#lJ$hPbLjVmtaOAp*3|E1NK=JVx9o}4V#&S1 zn4)A&HL|_ENqf7yTof5NFpb7z^!o#h2Yue!9MYYq_u*VX(I0WYpHY$}D0&65qQ|`~ zqn*8dO0t5pqQH2xg_GlBnop-h-ig_wq^mbi&~+V25JFg=TN{Ffb!L4{0>L>1A}q^> zZd|>Bz1=Mw+Q~>Ak7wv2#!G za#aJw5P_N4vn0XB7>H1_4lT5bvA4H_7vFy$@9*^e@!?HgE@p_N;NZc%Ud~lrahjyO zxi#Y8TyQRUjuUz9#tlqnHLl+{CSp*)+VJwcj%;Lk0j(4OP}kYut@ptN_RewJwcK=; z!Qd=SI7u^h&U4+gT$U|&t>JoEbJunpoa3f$xUM_yx|TUu4q$c;aK^Ea5_z6+S+~5J zFHw~>s=7v7H`Fv8q!ds}up~ig6j8NY61xtau_%{IwzlQzVimfo<+3Wdu3J_@@TpV# zys^2#o8wI=8S!v5;#F0#^MaEo1~IdBfxH9RuEWvcO>B%eP!xUY6@BEr5u7nFZAnGm zL(>{`)wawko0Y`gg8710s*QY!*%17|%9nAt0EgwHA?N zc<(?QkZFRcYkKmDr)hh4i_V<68%k*eZ;3-t96;VNyblxtlQk9`f(Xu$77XtUK`$tHo1KJOg7L z;4Mtq0$8s;Dk1D{jvz3?u-8LChwE2wAde$zs!}wo3R$eMzqzy^;viqLfyU0p&1 zhk8{*+whcN{_UgbEc0!rSgRNz6b$M~t@~LT7tY(B6rvCaeb<)4_#gxkq!3_Yw5>&m z6967f*TA$Ld~j&$7S=I@5Kt0u1jKQ)W?V2pf7HjaYLFx`1QYSq+L>&mL?s-`tkD>EK$ zw8w{6oi$|}D1^KikrELvSF=tj)RB<(>>WE@V+PfQ3s)X{_WXIu)2wH$OQaNerjRQs z5}`Pah;k`KR<|NPx_QKZ^0AM}SHAqgbTHhE%jGJq%0=p37Z}2F@Lp@#`4B8KdjO_C zD(v3&1}L@tEB5AOX&l4VP3NrXj1c5H@94~#v)Svv?4i7>tMvMDne1+DrNOnB z&sR@Rm-S;IbbI4LGJ4Tn_vB4yjIpLI+p?}}S8rzWSUP_lpv&6(Uwh+!c;BV}(?#^A zfAG3gy4j#ebZ^y^J;Ue?@?uceRWUD1t#u@`IEq7%k@rqBBO)QRB1DX!lRS@{brJgz zM_MYWWdv{($C(bc(~(wjl%&yYRq9BqD2bxTS{uc2k|;rW({y?8F3MuPc2}%w7;BM6 z3fr3_42vAQJDb?q+(2FwP+9@NGo3LPPo^g)wzIZ#&Tw#D2r$=fPOOe(+t1UsELWWi zzDpC`5@c{TxVCNDERS0)qpoqrS=+R$*@;nX+paU+s-9WbE}Q3`?d;8)Fn{LI0q}oQ zgi}BNqi+-A*k&iw}Ij@8!2 zDBkE7(QIXq3!_t=QM8r z=mCA{`kZ~+fQ=20JUb8Xf8@grfCj+L&u8M8SpZKFmgnVDfAqBY)enA1ET&iG!S0SM zYa^q$l6^grGLB@|tyC;i)izC}V?-QuoTRC8t&gYWYRlVdx3{;mJuIRqOXzD>)uN$b zKA6nq$EC!LEYD6>&2sjt-JW&XGG zn2`VWJ#WN&fB4(}zn}lHZ~qFs``>=U7k%7ZzfT>V`?k+}Qh)Ro~BFub^rhX07*qoM6N<$g2_{vzyJUM diff --git a/docs/conf.py b/docs/conf.py index cef9f7a4a0..a99cb50c41 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -110,7 +110,7 @@ html_theme = 'default' # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = '_static/pyramid.png' +#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 diff --git a/docs/index.rst b/docs/index.rst index 594d8697fc..17f089445a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,6 +29,7 @@ Contents features requirements installation + settings technical updates contributors diff --git a/docs/settings.rst b/docs/settings.rst new file mode 100644 index 0000000000..3974b73eb8 --- /dev/null +++ b/docs/settings.rst @@ -0,0 +1,268 @@ +======== +Settings +======== + +Mayan EDMS has many configuration options that make it very adaptable to +different server configurations. + +Documents +--------- + +.. data:: DOCUMENTS_CHECKSUM_FUNCTION + + Default: ``hashlib.sha256(x).hexdigest()`` + + +.. data:: DOCUMENTS_UUID_FUNCTION + + Default: ``unicode(uuid.uuid4())`` + + +.. data:: DOCUMENTS_STORAGE_BACKEND + + Default: ``FileBasedStorage`` class + + +.. data:: DOCUMENTS_PREVIEW_SIZE + + Default: ``640x480`` + + +.. data:: DOCUMENTS_PRINT_SIZE + + Default: ``1400`` + + +.. data:: DOCUMENTS_MULTIPAGE_PREVIEW_SIZE + + Default: ``160x120`` + + +.. data:: DOCUMENTS_THUMBNAIL_SIZE + + Default: ``50x50`` + + +.. data:: DOCUMENTS_DISPLAY_SIZE + + Default: ``1200`` + + +.. data:: DOCUMENTS_RECENT_COUNT + + Default: ``40`` + + Maximum number of recent (created, edited, viewed) documents to + remember per user. + + +.. data:: DOCUMENTS_ZOOM_PERCENT_STEP + + Default: ``50`` + + Amount in percent zoom in or out a document page per user interaction. + + +.. data:: DOCUMENTS_ZOOM_MAX_LEVEL + + Default: ``200`` + + Maximum amount in percent (%) to allow user to zoom in a document page interactively. + + +.. data:: DOCUMENTS_ZOOM_MIN_LEVEL + + Default: ``50`` + + Minimum amount in percent (%) to allow user to zoom out a document page interactively. + + +.. data:: DOCUMENTS_ROTATION_STEP + + Default: ``90`` + + Amount in degrees to rotate a document page per user interaction. + + +.. data:: DOCUMENTS_CACHE_PATH + + Default: ``image_cache`` (relative to the installation path) + + +Converter +--------- + +.. data:: CONVERTER_IM_CONVERT_PATH + + Default: ``/usr/bin/convert`` + + + File path to imagemagick's convert program. + + +.. data:: CONVERTER_IM_IDENTIFY_PATH + + Default: ``/usr/bin/identify`` + + + File path to imagemagick's identify program. + + +.. data:: CONVERTER_GM_PATH + + Default: ``/usr/bin/gm`` + + + File path to graphicsmagick's program. + + +.. data:: CONVERTER_GM_SETTINGS + + Default: None + + +.. data:: CONVERTER_GRAPHICS_BACKEND + + Default: ``converter.backends.python`` + + Graphics conversion backend to use. Options are: ``converter.backends.imagemagick``, + ``converter.backends.graphicsmagick`` and ``converter.backends.python``. + + +.. data:: CONVERTER_UNOCONV_PATH + + Default: ``/usr/bin/unoconv`` + + +Groupping +--------- + +.. data:: GROUPING_SHOW_EMPTY_GROUPS + + Default: ``True`` + + +Storage +------- + +.. data:: STORAGE_GRIDFS_HOST + + Default: ``localhost`` + + +.. data:: STORAGE_GRIDFS_PORT + + Default: ``27017`` + + +.. data:: STORAGE_GRIDFS_DATABASE_NAME + + Default: ``document_storage`` + + +.. data:: STORAGE_FILESTORAGE_LOCATION + + Default: ``document_storage`` + + +Job processor +------------- + +.. data:: JOB_PROCESSING_BACKEND + + Default: ``None`` + + + Specified which job processing library to use, option are: None and celery. + + +Document indexing +----------------- + +.. data:: DOCUMENT_INDEXING_AVAILABLE_INDEXING_FUNCTIONS + + Default: ``proper_name`` + + +.. data:: DOCUMENT_INDEXING_SUFFIX_SEPARATOR + + Default: ``_`` (underscore) + + +.. data:: DOCUMENT_INDEXING_FILESYSTEM_SLUGIFY_PATHS + + Default: ``False`` + + +.. data:: DOCUMENT_INDEXING_FILESYSTEM_MAX_SUFFIX_COUNT + + Default: ``1000`` + + +.. data:: DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_PATH + + Default: ``/tmp/mayan/documents`` + + +.. data:: DOCUMENT_INDEXING_FILESYSTEM_FILESERVING_ENABLE + + Default: ``True`` + + +OCR +--- + +.. data:: OCR_TESSERACT_PATH + + Default: ``/bin/tesseract`` + + +.. data:: OCR_TESSERACT_LANGUAGE + + Default: ``eng`` + + +.. data:: OCR_REPLICATION_DELAY + + Default: ``10`` + + Amount of seconds to delay OCR of documents to allow for the node's + storage replication overhead. + + +.. data:: OCR_NODE_CONCURRENT_EXECUTION + + Default: ``1`` + + Maximum amount of concurrent document OCRs a node can perform. + + +.. data:: OCR_AUTOMATIC_OCR + + Default: ``False`` + + Automatically queue newly created documents for OCR. + + +.. data:: OCR_QUEUE_PROCESSING_INTERVAL + + Default: ``10`` + + +.. data:: OCR_CACHE_URI + + Default: ``None`` + + URI in the form: ``"memcached://127.0.0.1:11211/"`` to specify a cache + backend to use for locking. Multiple hosts can be specified separated + by a semicolon. + + +.. data:: OCR_UNPAPER_PATH + + Default: ``/usr/bin/unpaper`` + + File path to unpaper program. + + +