From cf490e7918f5a795f6a945435df66b3e4f61f918 Mon Sep 17 00:00:00 2001 From: Brandon Taylor Date: Thu, 21 Aug 2014 12:32:36 -0400 Subject: [PATCH] Changed toctree max depth to 3. Minor refactor on headers for usage docs --- docs/_build/doctrees/environment.pickle | Bin 17014 -> 17163 bytes docs/_build/doctrees/index.doctree | Bin 10836 -> 10836 bytes docs/_build/doctrees/usage.doctree | Bin 31140 -> 31104 bytes docs/_build/html/_sources/index.txt | 2 +- docs/_build/html/_sources/usage.txt | 4 ++-- docs/_build/html/genindex.html | 1 + docs/_build/html/index.html | 13 ++++++++++++- docs/_build/html/search.html | 1 + docs/_build/html/searchindex.js | 2 +- docs/_build/html/usage.html | 20 +++++++++++++++----- docs/index.rst | 2 +- docs/usage.rst | 4 ++-- 12 files changed, 36 insertions(+), 13 deletions(-) diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 01236e61e81f1a2da644bac3d96990d4cbae3473..e8092ae032820d348280fe91fb6805cfa233a583 100644 GIT binary patch literal 17163 zcmb_kd4L>6)!!r}n@sKi;R-Or2G|5r{TpoCVH}d`7tFGRjnH^aD{A2sodsVOA@vEw? z?y26(N4DquiYSyecQ~bs3$k45cS=EGQMFLaFNq1f5oK?r@_x87~u|3(`M(OnW-T`*i8k-YHjC4xgfwp&0y(82W{VGQDDt2(S^3I7IT+^3FFNC|R z(C69g=S9lPM1F1v{mjPw?1}lAi~P*T{dBaSy{pXSB}r zR)eZ^yp8NwQF;B5W2Mlsa@?^>%rP%=OvWAawPOJsBb=79f#m99w&Z(Ncz3b#Hj#G? zm7C#WvChSD=t1&i%oZJQfW5p#d2fll+!7y$D(2m#ai1=WT)jLThg-FmZ-tj+V@+h^ zZE*4J%G*XR*4Au?f0xwxN6S{#&-OXq4)$%Q@^(eOy(8}16*1qgjNG{@bm!{0x9`-x zy$ik_g#IlbLucp}%ew~NzFT?kA#dNT?R(+>&N}}mqW@gE)LZDQ>NI=1IgV?UcU=_6 z`{Hq2AB*FLxYsv^q1+S&ce9S;7Q~T)oijo^&7*lgqWOUGK1k6FPvb*~>Ds!OXmQK) z`kv19``#W7=vL)@I11>tctE$u0=gp}(4ApGcSQl+tpoZ90-6pZ`X-V-W5wF!@>1aR zg&F)PqWGBd?x85&pxMXa`mMFDSFJ?8+@HmLFdJmOdzJSI%t1fMEANx-xU-karDC?n zDf-I$6e8#^=k*=))7JRPK-#cY%XVvQpHtFx_lf&RFvfSXGAF$IO$oxPHO6%JnRZd% ziP`WJ%Q;NFL}s1D1TOM4SuM+(2NK=`bxryQ`kWx(ZNY=qgcap{wdf!*bWeY1`&RF> z;z9AyHt%!Wdv*x+N<1JQv_|U&52L~7(cs~2-WRCB{o;Py`l-SAwd{FvHBGWd(Cmw7 z_Q*ExOK4WLS}%5_k6X3(<*pX1wcO)6xxn`xRmg}e_mwMj8~0V!8j(}pSK7s+N}yrY z8d(`o-dBmYT9G$6>YExD+5OsJ%Tdw~l=t)AA8UXHRdC9VnJ%XE=Hh0>@+c zEbUg(ez;rdL^pmX?>O^R*4Dpg?GvU1(=3Cjoi9)hyzlR_#^nlnU*mf}K-?yCk9W<+ zppZFo=ZD?%|6lHSKeEQ?<;45386BEW=-Hp}eu7*)p}e2ATazjSeYDr|Gk!3D)%|C1 zgLmiNlh#xb^cRIwtYmt!KJT@?pIg)QgyT({*|Q;VD?yDjfpD;;e9D@lJITl(AIhG# z68%{}aAXFpyebo z<2PCEO@>3E!IdFSS>Rf(49G&C2)ti+?*kX+&6#`b(aGBGttrmt zT(O#WG8H@_I1)GG-`L)7tucB4dB4kw$F0$GJ5K1B(7?ZkVfzCZSN25;u&ji zJt%n$njt7&u)RNu7qeX>0`E^*Yf|9!SFl7lJ{b|-pKb3IE0Kw$-m6(_GSzR6W%e(& z_t$puoVDK&DeXX0@q&2K8Uuf-*<#@REo)6-wCVY%kkfYlZhQZ*S}}@99!?5pe@?)2xH*=zt;tx#GNo#N27$=}#N)WrgzmI! zglOw(74twB;BOWFZ2WD+-$2($v7>9O*bTa;YedzWie7r~tcxiau1s<~df_!tPC&^@ z^p>loJPib2PSjO$5*dm;{>sTz(N_1kB&R?ce?E~@Nl^b#Ag7sT;qF`RO@hHquiS_D znjNOxmqgK~PEIGbVUHyDBXR9EL+%fmvu%w$0Mtqp%cVa3OfL_FK*@t}1u$ZYXcIHV zJaLRzAQp;MVzscvMPj2UiUDzn*dca`-QrrY2Rj36Lf)x3xP6v#1jP*M#+nkQGgBz> zZ1&~B-2EZAiZ)vwN@nWwm4tAJC{iRIjP)>L>w;<{SwmuHl9Zm(OkxiwL2V+BAkpB9 z40)vC^#g}&H+_W9m~s{bj&F^l)gr?qdNw4=+6xi;@+d0Hqj5zN>t99mREtF?$P^2H zkdSG#nYC4RutFy*=(h-R4m11OV!AE%v&H_lz*`QyACPlVQQs$ZmciQ4pOEuVjUJBy zQSw;sB<%4xX6k!Pxn!I=J|5KE2DACReuINo5Lj;lEKD+sEn`I_ zrz+<&(`bR5Aqyvi*1L`uIGA~*oRg5Jpc);Y3Zmp`xJDhHP7LiSbD}KyT~>>L8BU5d z23=HT0mGG3WsNOhdy7`ZomG)?$xX7ofN1;$kX#7Kwykmzh>~aE3UeX}6>>mtb;m{C zX?|)$I>L4l0Gb~k1G(BG+T0N5#cXSdw#9FY++Q){uHBmrPK+T~zOeSe*?<$rY>;j)s-Y)Z0zDWQz1xfx00gt5H_+9M%Zc*AP>S zNCZS1MS)m!=SSfwr3MjlhAgZl`d_~5lIx%h@GKA|&&8F%!|N-Te60shu8)L`2+D4* zG!UH!PRa9ejYi)E%rsBcg;Z~#vRVJ4xPGRIKAECKY@m7rRThkrJ**PuI>$_-eKJM* zc~AqDgR+vntP!gB5mN)zfo*=ZQo+vL$*1*3DIMNn{o#U0Zjx<5bVm09SYOwgKF!nr zx%z3xmjyHeST2Z?8*xQy-$bQI{ia+BhtYH+2;Ew|`nl7R?o>~yGBeHdRiS!=m&f`t zuJ1R|CsP!20BYc>qO9b_tP$pW6EltG$r7n=1~qUEpseI2tP!feg_s(+Cboqj%}pPh z-aK4{$TKpxg{XeJr8lj~xgE!LY?cagfO08_l9%C1pwQj3rq$)7opQ;~p>d#h#p9yo zPj2OgCb@3~r{vpkjV9CEnQ6?9N$xh(o8)e1^&N5bolVrq5=FZU)Fk&EC@XmdYlO+Y zl9*=6J#P5PCC|v*RYYfWPaaI$X{RE;$05I0qYC+bCy0{o!jkw5UxPO9p2<3*}a9W=-1!t(II{oS?O#_ z;)fFXepCU04}d87L2jqtgV(kD5UKzGd5xR(4Bln(v!&bv5qh{4M9B~1ifoFP<82{p zIUP-I<0iN3CbUAe;Ae`kOM<6<`NFiRgX|9O;ZEIyUdZlZra5GHQ@z3LBdq_?xc!pCGTu)F+ARx7T>L!d=XlpMns% z`!tA>_u)!Ygm&hGP3|YXluO{O;S7Ba0PmDFzJT&56Uig!tXtVTBo<81v4(zh_qIYe(>UTq};q$63zd#+W zbdw<4dZB9{;2@|U>W#^o<_c_x=1LQL!&<{E%WpxXac#DeJ%$!aejC?lCHoFDjkubX?7OHp zv*LTK{{6W651OcxB^s)agPK|KLzI>L5o?6#|CpGXS+RE;UeV#FK|hUGWNH3!cG&ZS z{3D}3Av&Xb8U{b!F;izrbe7be$tO^YiSknrC4Yu1O_U~WpQN5rE_pumj2T>dXkn_) zJJo8Lm}lnJ&)M!%+OD2kPcw78El#k-iMBY&7W%hb`3qE-yU;VN_sh86vqS2oTrxp< z_!X$Z?m3i|e4aJJZM#VK{5Xo)PV9g zl$HEDYlK<-2Q&3%Q!ZH|^?!mIQ2vFolCQBwsQzzant-wZ5l|?)bNnn{`zT4ykcHQY z*8D~BS4fKi7O$3ALw23pdJx93JsdUBKL|aV;kMkkuVOB9K&L<%AnK=Udgez zM$6YYX4cwboh>X|oNEjHE51yi!k{#s^(MsiCJw2Wa>)cGVG^i8X)?-6PGOBO%~P4F zH=Ap736-X!SvZ5 zM9BkiC9rTj!6irP!D@z6*zS#|k8OZCkZm2LZRzPVgPE)?dTf!iMcx+r*n&J56$Y3? zSntrdUUEpiluITk?i8p2<}j3%Y-5cuvoo2gH=A|Wu?3E!NL%Rh8gdRQ3?g$`Z(dyQm?8C2E}5W!j|DY|9EY-!$FoM5(i51eH=AIo(ef&ISoX~({UwO za1_NQH~y!v3>a7zu&ssKmWE{!Gs+g1+Tt=>Ty6_}Kt-N`3Ioex)>{(STRNm($|VyN z^)jkAxSR<_$>ppPCiX05>h0p4C*-8x1!{0P8)dxmWQ|aLB{8+QL@U<-LZDc5=Qwv$ zd!r#|$igb3b%$`|Y6t}Sz5&z#kVP3UGFc;3 z&k<7tz-+t(7{Io3~SoVS_*@r7K{~z`N;3;+n-i^?9HMDiF%Y`otO8Tr4;u}}yrJ0J8W-fWvFjG||9Ac(k%9RF;%fKmlIj#{HTbXH| zl($m70p)G1|Ms~4wkG;yibCE_^#+t3V3gd+Dq&W4G1F+DOp*ROKn*BYpseJTtP!eT zMNADSt!+4bg!5d(#fE$$Lst{kzr5j?6*`dbgak0W3q;9laHUB`KfmgF;6V=Q2^4|g z)@Jtq{i8@)LIIagZ`Mv>VC2wSnFkv?_(`cP6 zk^0S`Cf~Q9tmOMyBUJwYF*W%w4s`|$Z(Iz#6ahl>VzOm2LT z=#1`}$o4|+J~~iNC(W~^r0G7%-OCT5J+RsXqU5c(5>~_229gx&&`8!Tg&#HzYnQ^? zSWHWyZeRes9dae_z%`n2cQVt6fSECOQN2O%Zr1-uT>qm@^vM*Z?qi?^!Fy0v^5d)# zB6u$`H3&vO-0(T1;UYzzk-1M0t@+`G&yvYcLJmYe1)}7qaV11zKiqIDWS(3cI`d}L zx{tfKUw5JB&}W!w%%RD_15|G?c#!oUitB&2i9VU4pgsp`Ab1#MB|py^VGh5*Orv?S zMCy-#8VJ6KvXWn7jZpo|#MD5rPg{7pi6)X)b>sk!Bn=k{a*(V($~IJL5?ab81aiwXI4RO3bSH@KH?hP}{n{S6z8 z!|k&+Y`~`_@>^Wnm>#k~jy^_IznmIWmEVRGZhi+u$?xK-XH3c^llrdL8hRtY$0C|; z^$Rb(7_6Ow-{%g05OoL#A7`e~K?DB}QE%Y?5v%_=uKtrI>ST%HdjizJ|5KFlGL$t! z_@5-E2LAS;;7|9KB`u_d5*=Rr&z4bgnmqYA+ie^YPeG1cKMkVfFSyZALxP;I_P8PR z&v5HshOLK&{#mYV%q;ap4*iN~1N6^93U{6dQSt>`4fJGEFAf@UsM2A~BvL~+0iBxg z7Vx6(8QljW z)pRD9RuNx!O6O+7PUT9L1nN!NN209cDAowmz85idY3JjmyaUSN@Nl_59i7b` zZraIDGCmr;hiP9zXI6Rn)}1D!PURT1LfTtF@XD4P3e(?gm$|Vz&rYTf! zFrErV$!V+-g0wd?^>$M(nIiptKn=$GqO9a})(F-2Bc=x9!Czl?Qxu3rcYbsI`xkPC zEbLEom>=lK1JD?F9teUXt+)bDfp2hJ@=f3O27i>1Ga}&-PkRS*rGexSa7rGEt6olV z<4ZErJT)oQ8)Ob+^|rYB%qHq&iQ+yS)Btk?%6JFN8ewMJnQ636mPmaTr~zg+%1R!^ z8ln2p#MA&Yu}z;(Pxm|dLNr~&U}l$AV%HNxzl%1pi4luMRK{WMSm z-svbSxqvl7^@YULfHyd+_D~QAMR$I8{j4Hq$igC`Z}gRzJOeF&++q+Vm*7fM3Ezad zUMP&fmM3GyO~1;xe{4$;P2^G0zqYY_ZA~wk7U7Z%eCIJg^#~xAOC9QY0*Z-9k;x`-?L&K6}w-$=DHii0&Y-v@v%i> z6&G8M*|JjDRJ)(a%X7C|HUVozG3&#m| zSraOb{w^s~l|}1N5d@X_ot>LDZR)7-hb0|l+1HtOF78A-zf+zK7p+P7(4nT^Nt?0~ z-{|$BXZ%ZmesgMuzV#13^)P?QsildzBxqRiaElbv{S+!=%+9l^MS+itT=LK`p$J!Up zl53#R)v|q!TuZ8B$+g~UDJR!~rO!-8;r}Iwk=6v+o8u3%IPinQz=Lub|DK@W1ic(M zeS6a>E$V1G9eKg03iy15K0?E1CG?qney24#{8Es8#$ouK)}%tIQVq}|M_)DeS>vif zZ~DZvU+9zPqN}Pkg^$nRa}vZ%|79UB*F&ykH?Hk`Rt6uJ$n(I7wk*EGI3FcGWkcc% zBJqVJrt>r;wj=RHB&PE>B+f+Q4J4)$IV8?T;vN#y$s7{rB5|I?bdra}P9*LnF`eik zabF}BB&NeZBrZf^m&9~tiNqTtaS6)!!r}n@sKi;m86rEXXD>yGaOFrsrL7chtGvl-r4N63v%uV zs; zS1sf=BF!@J7P8C7DsNHb@^NvOkB_;0LfqvOBUeufonNe7emz_!CFkx{ax#25MR})^ zFLh0)!N_CdM#98aa2E?Xr{p`{61H!t@|H#Ro!%jivPFk2=GtPOEy74IhgxDhCuCd! zoo6WTOwt*rp9O_WS)rhCOaaTrQh8G;UGV)XMrAiEJX?7^k-~H00a+Of$f_s?tHT(q ziHGQ19gwxKY#P+`keXySsp;_Ndh1}|dgWPU;0Vpyh#OXj8RkZYZ43=7#tj?NhLvC#<>?GokX%#DmVB=a>nh6g$hw9`2@?n6CVD<{ zJqa=-Pp@pz@dCE9s=P}gJ2%Dc+#IuWIBwOYp{bWe#&6MfD%eRn)hHY~o z-|{hdMqY!wYhdl0mG>61_O<%H74~0IXa7{l&y`C9g~6&0v$vc5xK?>@i~M+dJjU0> z?7u#4^$n3TH-^!EhxX&0@FN91r-yo)dvg=Kd6)8TCT~W^@oxBZZJkfFT;+MiPUnVv zZx1_ki}KzRIrQGRL$}5px-IU|?U6%wgbv-Q9eN)enhhoTv5-D}<+@~dDR2hE2)-X) zd_Z|0Brjg2+lOHKEw!dstwg>&l*N-R8)Ur?EAJy1L4J@|-bXv|tS*&H#caP*^p$rP zJQynH^)v8e*5t}?+Mrg;4r}6|Q_^jBi@S+1!FRGUC%k)14aBN7!HD~Kho~1~wlKwV z4pT3YSuZh#i#$!%$nxglgm-UUm!aW7CkXgKf1fpFWjS9hItUCsrSIRd)%%3FPu#!V z`{a)PD+OC6?iKf0<8_Az(BV_)@W6KO)70S}aStBm)M4^Ewmi9pCfS4N_8D}0aJ%JY<$tmyi9pWJ+(6MTbtqd#g z3xr#(h#L&`O^b`@esOQlancWz_oWyiSHT+g<%m$VrVbX%{h6Sg3#5am(O2{~?W@*= z!Vqlsy{`${?|og9ztK-Q=C1jI^uF15HU?6c<-?7x{(&GnTrA73aP-0j_Q&8^+JB_| zaR1Q-F@6{CA@fw%+P`J(7ls7WEQ6_?FHj7;hj&?%as|Cp@x5=uZxgvkdgftJ$Q+sT zoxa8YFLS)_S`+kg;(gDI4vi=D>`!>#M=Tyy-VZvgX_etY+CBLhKN!a9{zI6-`)%(> z)=Uu$6@^o*Wcsr{@1DIMTeJ0q<87GPg~4$vL7g*!aIi^y%$lKvWMq&JX+Ns? zWCp#xpIYPf)Og&Qs<*-!zdA5b*zEnx+NTrgwq{}w7fJ(V>dyN+-+RLLp6oD;Pg(np zV2Ss1UwgDD)a@0M%i}vm?-|}bEW?b-mrKd@oOJJ5@wAm(U2>Ae0t)QjbF#qWH(4G? zhC`v#n!2*!=bR#*r%t)*2j0)K$ZNSWEDM7o@P5&^A52&{f5D<-lC|Qk8P4Whv6^=> z73}#PiO2CTZSOg2f*wHL^I7qTHGV3)L{klUuZtbfFC67Tf z1jRG9_Z#tSwr5P>{Wfb&3!I?}mI%iuCBpli?fu?LWFo5fhpaW7+Be4{`$yaRQ-^rU zI$(s5cA~3zMm%dxfIZc0G4TGJwPtX(>5Zq5(|TUCy_c+3j3Od=e}R&{148%stL^>G zTGn+=pbp zZjzHoQS1#?Ca9sk?u|!IChC%gjlY}%I=?A|J8U_X2zxiSavI?^dq_E*NYS=U&LFg5 z7bIsAxppHVXMyHyUn}afha}0Ee|3! z^#M8<#1XuhL*%`_wh>zA)FDKxf1{Fz5|v)TOkfWqLTw|`OK#4bkaC8k_b zPJ-tHng?ArpVy}@I5xnF5@6|(S!@a`A|V%`A2cikQ1V!mW-lriG191kj3Euj0oI$2 zLl;c7QqD=pk7(3{ywk#!oM*$|GfUz7liPmU$I z+ArGOFwdv5uG6$GKH-r|7->9FkW10vhS^-ke5c3xmXFAna!CdGyMo%?Fjr>)QSwY? z2}i?OjMVE*xulBty8+!WBWI(oWDj$M?B@_tn~^9H?Q|}J(-AHFXuOBiWQ2?%4J!%$ zm*-P*6_}B{)c{JaK}pHOk&{cd)+bM%8xb2bDA#hMNzpoBO0Gv4jXsN!=Ak-|+D)o@ znZGa2e|{5wQbmEdfZ9!}E(D_FMa&Y$+GeCtKdB=AivdllGN>!LfjL6cT%+c$;-H-3GNnPN-C7mWO@T5jnOf| zeIwdUa4%=}t#S5kP1s2jd3yz*3GSOvS8_XZgu&fGNVDJ`H~Qd`Wu)#(f^B`%_lE7% zQxMLVR}tD0vl1itk7ruO=BOm#l3XVpqr2L9pY`7I_UbfgE-)fqygTO1=eU z6!^C?(inKN3hhR_3H-Ip{9g*-emA2D z2_UQSux{gBCciz(cY_28djOQY1tp>>UWoSvt>rXyc@KAaukJ#te+zzE2t`tQ>X$D} zo4Sy697tnl0}7ad4LdWqIpZiXtE!0JJ-L2(y=CpLLM({yYM2O-Hg|_K=h2Y zriAZm{OhkRzl@$8Y$2QGl1(ld)Omjzc*7?&qg*2$tp_R7X8O$Uai~J%Vk0voQE^icG?i5SG-!FWO9LJpR1L<7tUW%CA`0ueC0nl;1E?KQUnRZ_!|q z@;m1HeVp$PBl4wOQb9id5zr*%PpB*TXXXf_`XVFsYEv$0BKDU6O;Y}Xx{`loj*$It zgfvOYlKRE7HYsEbX?U4n%@6SM?;s%~{{T?(pC~CK`1Rc-3plc`@=T6Rf^HM1Yu7OQNr+7@eUp?`CiEo1k_dkpG0+e8^HVB;96=S#Vyg524M*cSl7^JhG> zPl&U(Hen}C#6A(w#CsCzN+y^ijQ3wJVxg+wWTv9;}&jU0WIU02(k7155q-jR#)uvq1 zMC_e_CL>*_D>H`BE;aphzsGc9W}RK$JY4S;Am1XQW;)PBcL${uO{GS7)G( z15M@#+0P=RHdj%K0`daBXyIGxpY3D}Y3L?ccZo)x4I&cN1EAzNC@E36KjV@O4T)MA z5l2YWDsD8PUkwarmnfsqpUX(|5UfSJ$-p{hUms_;ny`~5^6xxAlYm~-mF#1VFoNeZ z(x{y@5&H#zCIJ_sj$=yZ2-$5yY7#IHulU2*6qoUPwoK>o3j*(u^Riq?mu23O_+39; zDOLvyrO~E}%qCkdCfL?D5Bud_F^s)3>qyqZMA0T*()0YJ$tN<{uYl!3&P z@0@ry%C@Uhi+w}H^ZU`M9Cp$3G-TFq+V~zB~`><1~kK>g1V9( zbA;@YkeXr9LLNZgReOKC*`__JTSLhh(%=((%?o5QKsRK!3ZUdAC~2nRrkG1sHO$ma z5pjf>x|thIGKPUEc`3>$8J98AJSbbxZgQfS{S9&UH#T7>P2}O>D+#H|Nozaq4&gf1Xj4Nrk)oXh_0MX!B?SR;7bwWW zRRBs}jgsaV{kE#xkq$CQ&z~pe z$dR`Lnt)%2x{}v3M;Ngi7->{bnuz^IKojtHpswUQnImMsiIAFrAK8xISZVz;7f{kc z8LML&*LC=YE!}~0ila>jSxjcUi(p&d5eWBE79U;lrn}$SQqqV|vUqtj`XgEI22gSj zN=nvfxsgh8b>vjmErqvmN0XoTu)gVCzq1KDX`;Zq z576Z2{irMX0pqhBz?OOd0^30X<1KSZ#t??B`v{Aq=6eZ}ut z$`7Lt^6(J=B|nOi^6+XLh&{Q{H1=+7!0%$gAJc+$!0%?HdBE>My9xNmnf=~4`+ZH= zNfUW}KcETtCs4;3DszMZe}IshfbZ8HUN)jh;Z+?ujN3w^jWroaT0g})+WICV*sJl2 z0`4wBTvC1-bj0^T03|=eoo3Z{LP*KbYJdF|g(7ZN$ZRnoKZ|C(l7Eh+JQPZy%kvvH z7=t_JZrFeiH{|EJwK2M+feifuL4Az0msNfdRG9fC042YSQa^7}E~(T{u-4ET`4uM7 zE@G2u3|CP)y{Jw9SJ4B9s3^5S82EKY8Vxk_?Hgz}>Hj9Pe=E-Za1(aYME-pn(4_wn z)NzQ)9AWyuOGr)nJ4Q->dY~+6Q7n|`BH@3wB$Cl&$@f@q0)FO zp`is`hbCOkf2M^z!9t$YLYnr*c-PL2ZVWxeLZ8+`^%C+7BaNP#G4w3j%^3PQv;QK_ z{>vupq=^Fc9H1FP&!di$RptoC(60!o8AEg0>0!zb)oMRh4?kTVNQW1xN4t`couvHN z1l#%!MyTn2F0CT?h=YXE9oA5&{0({`Yrh3h@^>g{-F|f*gq@rj?aKXo7X1e;T8I6Q zj5H7XpU`f?{%2-?G0y%{6L!)>p8o~Vg#E9mEBQC(2*ds|A$4KrJDAbzc_8PfnEsvKLM0{1*Hjla~_19oO!LVV=mObto@6b zXo~11l@{0LG_l*fGyI!vYZ=G3>Aa0$R8qC&c9O_E$6XzR0 zB45fS6%?}x)NT^q%KQ`K{F9pSlPcm*0GfnPMqSA%%n>GhDj_uq-}|GwOfg5uemEgDiJ982FOH{&oO~f0ovFM=mdG+v*G^C$Rj%Xv=gE~MMjin= z5^^K}ZndJM*+w^o;=Pa`GEvX3C@HSaK;6s0QKn<Ch|QF0#2 zD2GQga;q(Fv&HSUxWg9u+a`Go8cg!i%-0#`>l%?S<&p{t$9zDOyalK$xsW-+=pV~S zz1oyZnuvW7ph@0ws4ICqbA;?C5K@!8y|Zc$JRn!JaD1^{5!hmzEq2>t4}EW)Ef)1<`cs+jG|hMB(nnvhkAJE1q-f`A;koO#iiK3|d*Rv} zZxTy1_4$XFiEgg89J^(e=%wm~!8O(s!eMIPi<9pX0ap**KD}FPqv}PsY`x=rv77tO zy7Tdu#U7?UcJ0+S!yY{5>51>lC2Y@9vd7v#S1e~YW*mIfR?Oh#T{`p~`A+K)d~Pt5 z87P+n96~yo=+~``kDJrZE_~91uRStF=MtybGv1oz(`Q}Pe!g#?*^FJ>&@Oz?f)5Vz z`r9F2I8Lz3no@D}2Sb^vELw+&AgCe{qvQ)h+0_~Nf-M0U2+*rw5H*M zgc`ZiHf1F~o*RT@e0@J;F1yfY_2F0by}H9XZcoV5AqHp6Y@@$~=ImkHtYXX4_C~_djUrMp#b3(_1avA># zpx^`p>^OZC(^rS#g;J#&phu2A zHypGkRfB=_iD|zuD9?eYsx^aez2LJC_)P!MATL*fuH-6|9el+FAA!i#z(ji%pHHko zjW5R#`P_)SmdJDshREw8@_HiEwHYE?5&1kK(?uF0_eSJCBGZK$BA*|TFCa2qz#;O5 z5&0q_(?uL2+Y$L;GNnRL g!H4^q!eFV4A(1CG`Y#UBLCuG=wYDY=<>g*<){niG8_CjJ*?n43RP)rPE%}dNpEiN>TEi}vE+swhzCL^bmm|+x~VGx^P7@J`lTja>dz>vY8Sel_6 zTbh*NIQhMT-sD>fLDH!}o~mYJktE@YS ztf$G}zb~U}I+@jLiaBw3*l7CnqbIIhn&snMVO^ z$!CxyyqnFflzAa?n`7LK#G%Xyam7-a@?b3)av81}vKcQj6tdofv?yk%Wk_X#Y|4<% On#}~HlqTy`RsaB`r*AU= delta 410 zcmZqp%(&z;6fc2Jhw%%xyBF ziisIUu^9%j8HTYLrm;nij0_AJe3QEsIwy-OiZi-S)>l;KQAz|!d4i<)C&wwONrPPN z0&%q?*wvnJS5Ka-=!j2#^JB$Fywa(qNg1k|jYTtnX4V$X1dhRXOPW2n|ZC2d4Up}P2G*eL3B=Bv6QA%7RZbYxeV6~*^Cz%@>%ae ZT!jp^4C$=dOhBemmMcg^aWY3`1pu%ZeXIZg diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt index afebdac..12be614 100644 --- a/docs/_build/html/_sources/index.txt +++ b/docs/_build/html/_sources/index.txt @@ -39,7 +39,7 @@ Contents: --------- .. toctree:: - :maxdepth: 2 + :maxdepth: 3 quickstart configuration diff --git a/docs/_build/html/_sources/usage.txt b/docs/_build/html/_sources/usage.txt index 5b651b4..325aed3 100644 --- a/docs/_build/html/_sources/usage.txt +++ b/docs/_build/html/_sources/usage.txt @@ -38,8 +38,8 @@ Example assuming a model named "Category":: See `this link `_ for more information on Data Migrations. -Django Admin Integration -^^^^^^^^^^^^^^^^^^^^^^^^ +Django Admin +------------ To enable sorting in the admin, you need to inherit from ``SortableAdmin``:: diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html index 553ffc0..c82d028 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -66,6 +66,7 @@
  • Using Django Admin Sortable
  • Django-CMS Integration
    • diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index 09a57d6..410535e 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -66,6 +66,7 @@
  • Using Django Admin Sortable
  • Django-CMS Integration
    • @@ -150,7 +151,17 @@
  • Using Django Admin Sortable
  • Django-CMS Integration
    • diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html index 6804d88..35dead2 100644 --- a/docs/_build/html/search.html +++ b/docs/_build/html/search.html @@ -65,6 +65,7 @@
  • Using Django Admin Sortable
  • Django-CMS Integration
    • diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 35375d3..66b7152 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{all:8,code:8,plugin_bas:10,follow:8,row:7,whose:4,depend:8,cmspluginbas:10,positivesmallinteg:8,under:3,introduc:[8,1,7],rel:[8,10],fals:[8,10],util:8,context_processor:[9,2],veri:8,change_form_templ:10,list:8,last_nam:8,item:1,small:8,sortablestackedinlin:8,pleas:1,fortun:10,pass:[8,2],click:5,compat:1,index:[8,1],appear:8,mysortabletabularinlin:8,abl:8,change_list:8,"new":[],"public":3,gener:8,here:[8,2],valu:8,search:1,extrahead:10,stackedinlin:8,opinion:7,chang:[8,1,4,5,10],honor:8,via:5,extra:[8,2],appli:8,modul:1,prefer:9,href:10,instal:2,unit:[6,5],register_plugin:10,from:[2,4,5,10,8,9],would:8,regist:[8,2],two:8,few:[8,9],stylesheet:10,recommend:8,taken:5,type:10,more:[8,2],sort:[],desir:2,peopl:8,get_queryset:8,site:[8,2],known:[],must:8,placehold:10,work:[8,5,10],can:[8,5,2,9],caveat:8,def:[8,10,2],quickstart:[],sortablegenericstackedinlin:8,tabular:[8,10],minimum:10,mysortablestackedinlin:8,edit_inlin:8,first_nam:8,anoth:8,cmscarouselplugin:10,instead:8,simpl:9,css:[8,9,10],updat:[1,10],product:0,after:8,befor:8,mai:[8,1,5],associ:7,feasibl:10,credenti:5,imposs:7,issu:[],inform:8,allow:[8,10],tall:8,order:[8,5,2],help:6,anticip:8,over:8,move:6,becaus:4,through:1,dynam:8,group:[8,1,7],thank:1,them:8,"return":[8,10,2],python:[1,5],now:2,nor:7,name:[8,10],anyth:8,edit:7,drop:[5,2],each:8,found:5,inhert:4,individu:1,realli:[6,10],contrib:8,meta:[8,2],"static":2,special:8,out:6,categori:8,rational:[],plugin_change_form:10,insid:9,migrat:8,sortabletabularinlin:8,standard:8,base:[8,1,7],dictionari:8,releas:3,render_templ:10,could:6,filter:8,pagin:7,charfield:[8,2],top:7,south:8,render:10,onc:8,independ:8,number:8,cmsplugin:10,change_form:8,alreadi:10,stabl:0,installed_app:[9,2],script:10,data:8,licens:1,sometim:8,max_length:[8,2],carousel:10,schema:8,option:[8,2],travi:6,tool:[5,2],copi:9,specifi:[8,10],entequak:1,exactli:8,serv:9,provid:8,get_is_sort:8,jqueri:10,sai:5,changelist:[2,7],ani:[8,1,5,2],have:[8,4,5,2,7],need:[8,10,2],seem:7,incompat:[8,1],equival:8,min:10,self:[8,6,2,10],note:8,also:[8,1],take:2,which:[8,7],normal:8,sorting_filt:[8,1],object:2,change_list_template_extend:8,why:8,don:8,request:8,doe:[4,7],sample_project:5,determin:8,left:8,text:[8,10],directli:5,current:[0,4],onli:10,componentinlin:8,locat:9,apach:3,should:2,title__icontain:8,folder:9,adminsort:[8,9,2,10],hit:8,get:[9,2],csrf:10,increas:8,is_sort:8,tbd:[],requir:8,enabl:[8,1],method:[8,9],where:[5,2],view:[8,5,2,7],set:[8,2],see:[8,5],project:[2,5,6,7,8,9],statu:[],wire:2,parent:[8,4],enumer:8,won:[8,10],between:7,"import":[8,10,2],across:7,attribut:[8,1],altern:9,kei:[6,7],javascript:[8,9,10],distinguish:7,"__unicode__":[8,2],addit:8,change_form_template_extend:8,plugin:10,howev:7,foreign:[6,7],instanc:10,context:10,login:5,load:10,simpli:2,instanti:8,height:8,assum:8,quit:9,coupl:7,due:8,compon:8,much:7,present:[8,2],"case":8,look:[8,5],properti:8,defin:[8,2],endblock:10,almost:1,non:8,myapp:8,mysortableadminclass:[8,2],suggest:8,make:[8,7],referenti:6,same:8,member:8,html:[8,10],ascend:8,difficult:8,director:8,stack:[8,10],appropri:8,thu:10,inherit:[8,2],person:8,exampl:[8,10],thi:[8,6,5,7,10],admin_preview:10,model:[5,2],latest:1,just:[10,7],previous:8,foo:8,easi:[1,10],littl:7,add:[8,1,9,2],board:8,els:8,save:8,app:[5,9],plugin_pool:10,format:[8,1],is_board_memb:8,template_context_processor:[9,2],resolv:10,staticfil:[9,10],necessari:10,either:8,page:[1,10,7],right:8,sortableadmin:[8,2],some:[8,6],sampl:[8,6],slideinlin:10,substitut:10,select:8,content:[],core:[9,2],run:5,widgetadmin:8,symlink:9,"super":[8,1,10],src:10,about:8,column:8,verbose_name_plur:8,includ:[8,10,5,9],block:10,own:10,inlin:5,within:10,automat:[8,10],orm:8,ensur:[9,2],your:[8,1,9,2],manag:[1,5],wai:[8,1,4],area:5,custom:5,start:2,inner:8,forward:8,tabularinlin:8,"function":5,properli:8,form:[8,4,5,10],tupl:[8,1],link:[8,5,2,10],tabularstackedinlin:8,line:[8,7],sortablegenerictabularinlin:8,"true":8,made:1,possibl:[8,4],"default":[8,7],displai:8,record:[5,7],below:[8,1],foreignkei:8,problem:7,booleanfield:8,creat:8,file:[5,9],pip:2,mysortableclass:[8,2],titl:[8,2],when:[5,2],field:8,other:7,test:[],you:[8,1,5,2,9],"class":[8,10,2],drag:[5,2],directori:[5,9],backward:[8,1]},objtypes:{},objnames:{},filenames:["status","index","quickstart","license","known-issues","testing","future","rationale","usage","configuration","django-cms"],titles:["Status","Welcome to Django Admin Sortable’s documentation!","Quickstart","License","Known Issue(s)","Testing","Future Plans","Rationale","Using Django Admin Sortable","Configuring Django Admin Sortable","Django-CMS Integration"],objects:{},titleterms:{overrid:8,subset:8,quickstart:2,queryset:8,indic:1,order:7,exist:8,tabl:1,what:1,welcom:1,media:9,support:1,configur:9,custom:8,content:1,version:1,futur:6,rational:7,test:5,"new":1,document:1,higher:[],sort:8,sortabl:[8,1,9],extend:8,object:8,statu:0,drag:7,templat:8,known:4,inlin:8,why:7,plugin:7,admin:[8,1,9],drop:7,django:[8,1,9,10],issu:4,integr:[8,10],anoth:7,"static":9,model:8,licens:3,plan:6}}) \ No newline at end of file +Search.setIndex({envversion:42,terms:{all:8,code:8,plugin_bas:10,follow:8,row:7,whose:4,depend:8,cmspluginbas:10,positivesmallinteg:8,under:3,introduc:[8,1,7],rel:[8,10],fals:[8,10],util:8,context_processor:[9,2],veri:8,change_form_templ:10,list:8,last_nam:8,item:1,small:8,sortablestackedinlin:8,pleas:1,fortun:10,pass:[8,2],click:5,compat:1,index:[8,1],appear:8,mysortabletabularinlin:8,abl:8,change_list:8,"new":[],"public":3,gener:8,here:[8,2],valu:8,search:1,extrahead:10,stackedinlin:8,opinion:7,chang:[8,1,4,5,10],honor:8,via:5,extra:[8,2],appli:8,modul:1,prefer:9,href:10,instal:2,unit:[6,5],register_plugin:10,from:[2,4,5,10,8,9],would:8,regist:[8,2],two:8,few:[8,9],stylesheet:10,recommend:8,taken:5,type:10,more:[8,2],sort:[],desir:2,peopl:8,get_queryset:8,site:[8,2],known:[],must:8,placehold:10,work:[8,5,10],can:[8,5,2,9],caveat:8,def:[8,10,2],quickstart:[],sortablegenericstackedinlin:8,tabular:[8,10],minimum:10,mysortablestackedinlin:8,edit_inlin:8,first_nam:8,anoth:[],cmscarouselplugin:10,instead:8,simpl:9,css:[8,9,10],updat:[1,10],product:0,after:8,befor:8,mai:[8,1,5],associ:7,feasibl:10,credenti:5,imposs:7,issu:[],inform:8,allow:[8,10],tall:8,order:[5,2],help:6,anticip:8,over:8,move:6,becaus:4,through:1,dynam:8,group:[8,1,7],thank:1,them:8,"return":[8,10,2],python:[1,5],now:2,nor:7,name:[8,10],anyth:8,edit:7,drop:[5,2],each:8,found:5,inhert:4,individu:1,realli:[6,10],contrib:8,meta:[8,2],"static":2,special:8,out:6,categori:8,rational:[],plugin_change_form:10,insid:9,migrat:8,sortabletabularinlin:8,standard:8,base:[8,1,7],dictionari:8,releas:3,render_templ:10,could:6,filter:8,pagin:7,charfield:[8,2],top:7,south:8,render:10,onc:8,independ:8,number:8,cmsplugin:10,change_form:8,alreadi:10,stabl:0,installed_app:[9,2],script:10,data:8,licens:[],sometim:8,max_length:[8,2],carousel:10,schema:8,option:[8,2],travi:6,tool:[5,2],copi:9,specifi:[8,10],entequak:1,exactli:8,serv:9,provid:8,get_is_sort:8,jqueri:10,sai:5,changelist:[2,7],ani:[8,1,5,2],have:[8,4,5,2,7],need:[8,10,2],seem:7,incompat:[8,1],equival:8,min:10,self:[8,6,2,10],note:8,also:[8,1],take:2,which:[8,7],normal:8,sorting_filt:[8,1],object:2,change_list_template_extend:8,why:[],don:8,request:8,doe:[4,7],sample_project:5,determin:8,left:8,text:[8,10],directli:5,current:[0,4],onli:10,componentinlin:8,locat:9,apach:3,should:2,title__icontain:8,folder:9,adminsort:[8,9,2,10],hit:8,get:[9,2],csrf:10,increas:8,is_sort:8,tbd:[],requir:8,enabl:[8,1],method:[8,9],where:[5,2],view:[8,5,2,7],set:[8,2],see:[8,5],project:[2,5,6,7,8,9],statu:[],wire:2,parent:[8,4],enumer:8,won:[8,10],between:7,"import":[8,10,2],across:7,attribut:[8,1],altern:9,kei:[6,7],javascript:[8,9,10],distinguish:7,"__unicode__":[8,2],addit:8,change_form_template_extend:8,plugin:10,howev:7,foreign:[6,7],instanc:10,context:10,login:5,load:10,simpli:2,instanti:8,height:8,assum:8,quit:9,coupl:7,due:8,compon:8,much:7,present:[8,2],"case":8,look:[8,5],properti:8,defin:[8,2],endblock:10,almost:1,non:8,myapp:8,mysortableadminclass:[8,2],suggest:8,make:[8,7],referenti:6,same:8,member:8,html:[8,10],ascend:8,difficult:8,director:8,stack:[8,10],appropri:8,thu:10,inherit:[8,2],person:8,exampl:[8,10],thi:[8,6,5,7,10],admin_preview:10,model:[5,2],latest:1,just:[10,7],previous:8,foo:8,easi:[1,10],littl:7,add:[8,1,9,2],board:8,els:8,save:8,app:[5,9],plugin_pool:10,format:[8,1],is_board_memb:8,template_context_processor:[9,2],resolv:10,staticfil:[9,10],necessari:10,either:8,page:[1,10,7],right:8,sortableadmin:[8,2],some:[8,6],sampl:[8,6],slideinlin:10,substitut:10,select:8,content:[],core:[9,2],run:5,widgetadmin:8,symlink:9,"super":[8,1,10],src:10,about:8,column:8,verbose_name_plur:8,includ:[8,10,5,9],block:10,own:10,inlin:5,within:10,automat:[8,10],orm:8,ensur:[9,2],your:[8,1,9,2],manag:[1,5],wai:[8,1,4],area:5,custom:5,start:2,inner:8,forward:8,tabularinlin:8,"function":5,properli:8,form:[8,4,5,10],tupl:[8,1],link:[8,5,2,10],tabularstackedinlin:8,line:[8,7],sortablegenerictabularinlin:8,"true":8,made:1,possibl:[8,4],"default":[8,7],displai:8,record:[5,7],below:[8,1],foreignkei:8,problem:7,booleanfield:8,creat:8,file:[5,9],pip:2,mysortableclass:[8,2],titl:[8,2],when:[5,2],field:8,other:7,test:[],you:[8,1,5,2,9],"class":[8,10,2],drag:[5,2],directori:[5,9],backward:[8,1]},objtypes:{},objnames:{},filenames:["status","index","quickstart","license","known-issues","testing","future","rationale","usage","configuration","django-cms"],titles:["Status","Welcome to Django Admin Sortable’s documentation!","Quickstart","License","Known Issue(s)","Testing","Future Plans","Rationale","Using Django Admin Sortable","Configuring Django Admin Sortable","Django-CMS Integration"],objects:{},titleterms:{overrid:8,subset:8,quickstart:2,queryset:8,indic:1,order:7,exist:8,tabl:1,what:1,welcom:1,media:9,support:1,configur:9,custom:8,content:1,version:1,futur:6,rational:7,test:5,"new":1,document:1,higher:[],sort:8,sortabl:[8,1,9],extend:8,object:8,statu:0,drag:7,templat:8,known:4,inlin:8,why:7,plugin:7,admin:[8,1,9],drop:7,django:[8,1,9,10],issu:4,integr:10,anoth:7,"static":9,model:8,licens:3,plan:6}}) \ No newline at end of file diff --git a/docs/_build/html/usage.html b/docs/_build/html/usage.html index 2a84495..5cc8d45 100644 --- a/docs/_build/html/usage.html +++ b/docs/_build/html/usage.html @@ -29,7 +29,7 @@ - + @@ -67,9 +67,19 @@
  • Using Django Admin Sortable
    • +
  • Django-CMS Integration
    • +
  • Known Issue(s)
  • Testing
    • +
  • Rationale +
    • +
  • Status
    • +
  • Future Plans
    • +
  • License
    • @@ -140,8 +150,9 @@

    See this link for more information on Data Migrations.

    -
    -

    Django Admin Integration

    +
    +
    +

    Django Admin

    To enable sorting in the admin, you need to inherit from SortableAdmin:

    from django.contrib import admin
 from myapp.models import MySortableClass
@@ -173,7 +184,6 @@
     """Your generic inline options go here"""
    -

    Overriding queryset()

    django-admin-sortable supports custom queryset overrides on admin models and inline models in Django admin!

    @@ -270,7 +280,7 @@ The height of a stacked inline model can dynamically increase, which can make th