From f52c7da45b275de5449b42b343855c17231514fd Mon Sep 17 00:00:00 2001 From: Gregor Aisch Date: Tue, 2 Apr 2013 13:17:41 +0200 Subject: [PATCH] docs --- docs/_static/knight_mozilla_on.jpg | Bin 0 -> 5925 bytes docs/_themes/kr/layout.html | 18 +++++++++++++++--- docs/_themes/kr/static/flasky.css_t | 16 +++++++++++----- docs/conf.py | 2 +- docs/index.rst | 25 +++++++++---------------- docs/quickstart.rst | 3 --- 6 files changed, 36 insertions(+), 28 deletions(-) create mode 100644 docs/_static/knight_mozilla_on.jpg diff --git a/docs/_static/knight_mozilla_on.jpg b/docs/_static/knight_mozilla_on.jpg new file mode 100644 index 0000000000000000000000000000000000000000..90f256a403842b4c16184ecaafb589678308dff7 GIT binary patch literal 5925 zcmbt&)ms}5%x-aq;qLD4Hr(BZ40oq6oFT(ugW~Rk0>!N`7-PV&LWjE#hO9Wl&wk%I z=P&q@i#*Ajyvao_^5kXdWef01Q&mG1fP{nu(D00r>>1OpR*j)jeegp7jv4;Od^Kte?UAOp}) zP*BkROF=_HMaMuw#spwt6B3b-5|as%Ga67b+flHvvPJ)^Ap5V`|0nyu776)ZoP!X6 zjD&)MjP^e){{tWqG71_XE7~0Jtbf{{}=M1jqvryMyTbp}k>c zO|qXEf;+m2Ad0`Z$$ZFj`9NI1*Ajx;n3Kl{(fW+|Hj7ne8R6eyoa~JCM0_jgCZ7%< zgjm2YJ$~X@Lx%T-^$<)#2{KZ?`-^L@k?2&)5`>f zOM{ev*w*RDi;NC8r6%}*lw7r15e^kkv3vpij&4L)B4B=`--0^VC+T~ykC*SkKfHB{ zb00fH^n`eA_)4(A71V8O&O~}D*JK4-oxAhTrKOcGDdDEE>~1_VvSyA$z{lHaQD? zW$V-tm@ET-aB1MsP1AjnnWnF%0oV}AX?QKM89+ANDkGTG;oDZtOi2ps{8oeV@EY-i ztX!?M-I2MmCZCJI!72EgleLh>@ds2Sjm>9mDgwZ~rG4ZIxPgaTaBGz9&Ei>)$kdM< zk1qEUQ1DEG(}Ml-MAL&KIk3<=L&NDj3$z*T)h`SYPEG%QP0F?-4!WSmXCzp2T{)fX z$clMAmZ`tf86MG)$xSO|0;9%zJxB=i-ENc3(HWl-89FVjSk@7rs(FmdZ{v6f`jYNF zEIeEA(}NhZTqVm}Trrd4@;p^M66z{tKo;8LUjj3Rx20XFQJ;db59n0`_M*tv7#YJ% za806fqko+rP;X;YYs>kD)CIRtv=u^FoXh~Z8|u6&4y%Msr31c|sp%n!J+zd~wz9@Y zX$aBZdZkm0D|zjryUWepBw}~;)n2kFgL(4o}=T7G-+p|DP3sCufYhvjgVt9sZwAKY#ZO1IsbM4|O0rIZseHm~9A{=x+Dtx%2lu-M)y{}nQ7+7T&yDq-CodmiD z3ONY>oMWiDk<&)aqK?pkBWRUEiz~c+oYwLDy4Lf{*HHRAY#i!5zoHF%iX=tk1fsWv z?aOWy#JZ}{VR`qg*>JY#x1F|jGOVfI+XYm|ac3q4{(EJU{n>c}Aa%T2g7P?PvR63R zKjcNxD4bJ;`~?rGdXOuC8lP?woOF!rPOP?^g|Jc0N%lgW%Zf4-u*3q_|G+Gjd;C}+3fYZV=Sp4wZLn=;`(gVE(hX7va<2>zvrBy>HFD$pSoGhg^bhR!_O z>>qskOc2$EHKmC&1Zx<&2!ivzos^`eXHW6dlf%H4y_a-n8~!VS>t*Hj?U zprXM%YC1eFO&c6LX*W^hwJN#j$zN*!c0$$}7}4pfnH^`S5cXNeEMRF;aR`L%K2i#1 z*8BcL6h+t&yDZMQ*uT@yM) zp@q}4lY#E`vQQj9XPX) zx}O=5kOZd()RBI)G2x}LdRS6LoiBG=^&ll0tuaLMqS8!1CC1@}zg9mkk}xo_$lX+q z`&?NO#x^)Rl`-Gn>!KpIv@2~hLNE3NMQ?#n7wspfSEhbjn!qFfI8rqqxR^ppap4@8 zhzD$NGe1UGqW&RISeZ4}W9bxIn@s7ud!rSiS8bzyl4+3Xdt-2StD4-W8B6P+!59xi z<<#$p&W`sH$HU-o=IGN^pEk_nr`MyNdfn|S8TIY)*0qI~KNtZkoF*^{u+-N&s&jfE zHwzPUJMq?{&xI6=>0;t2yA8EdMNoY4fF??KL-OyAD#8xvWn8Qt zI~P42R?kEBsUUjlm+N*$lU67pOffN5gcvOyn-aLUm=r9%;tjV@lFRy^COUjW9gi7D)yjsJCpPWgIX9){9Yh*zL6D z0nWRgjZ6Xj>TS^?X{c66@R)vWQ8jw2Wrp`I@Q!3|{5N!ZiD5r9O%=+BpKZPR#r@;8 zs9{}0#$n16*KF<2?Ymr@^4VFh%+J5qjSCR;vvpU1Ubeh(JOL9WjZ7VkJh!$39^gP# zZ5Xx=OOg%E+@G4*t4HhZH`7`|3uzOqF~YE)(qe=XQ0}>}BYN>VV{XF1`tv*cm=y?L z)mLV!_{y%1DNlYSycp##fQqYLw!Sf6#^Vpw({E(TyZ7I)muH?FeeCEw!9iM~<@a&_ zHNT={@^&%!ILznKtWYU{$gdA?wa~+*3WR(D)6Qk~|B! zIdS)B6M;fhh&w{taP-7Ju}>9f8Z&7feUc2~_Wd)uZCYEA`1r}zjbr~NL6`5*hHG2) zwpUJNw3WO4L~f7wk~nxES#ed0L?1fpNT;}cXOrOC%g#?z=!Cgkn0CSNr>rJl7r zd&uW*j>hPI-?W*scttF?cC6ZNz1qYKY+_<|UX@fU=}FP?!bMW6YzOoTYIutF<3u`P z+`B^`JRy|?eQ2=CY!>`@#eL30{JbPsH;iPzjk|FW@W$)p9jeJ>ZMZt_SW z)_WSSSX~(3-a@D_h02e~^LcE@6qWw{N*L*>#JeV4{(k6%r+B~#7e##2H4nDu?Cj zRB>jI~qp(ztBT=LrTRJQtJ}QjY@l~p;>056QtyUI& zZ%2lb^@29}(8hB_m<`Pxy&)$^9_~uc(6v=$phu5Zi_1xyN^SN{9P$1zO1-4mCnloVld)Lf z-$6J;Q2GD_Ip`f{I(#I$Bpqj!cD|F5_Y_(>vgtYydN~p-lekc$X0!^a5unOD+v=<3 zJFhQ+G8#6oy>5dimYhgXpC6gO_T5PxaP^-HVKxN2C~hnSTul8+x5Z0ikV)c*bHq(7 z&@FD55=}Va!09@rs^_j}`SC`uXc@54;zp;iU4`cz6ED9P`(y(xJX-ix$Hd(S~n{0QW~Y&KXkTNBa%o#k%wq?Y~1a ze7$IR_Ov~O;y0C8r>>69;t#HH5kFKuEakX8lQ(~VBE~Y{66Ivr6aG7_{G@;7r(&&~ zhYs1l<4hf#j)O^^1H}C<17&9d6wdHNj``vb7PF_NEH8v1Vm^d(GR4~+FtriAz$c8e zRzq7J;&8^*0CXZ$VSMY3UlqG4moET`M>$efcbmsdy0mNg=H!8@BXd1NvyK4~i=Wtj z!%g^Z_CM^eT&3j(b)=%?9d|R4$hk1$nrFsQF-@#kS7--+|ll#TtA=0d~R zQN~-zUN0RC`b==+qhWM|czu=aG-fcajn}Ej4P)E$5y_j_C9;r_@Q`8ARb$CIphjNg{Z;;q!*W`#?zlf z72ZpfM=!MVyuSfb%kFKzUH73A;cMlXpPGsnV*P%q(~*9tZNX;w>Y+wAQ^Wc82|43D zj=1(=HOHdd?!2@^&LvFcdeWQ38bklAO9m=_Yc;iWUL5aar<*WE)vZg)BamExD+pQ{ zShshnsW5Xz@4k2en9s>UA~XYBRD-51uT;(~%Neh&!K_cCj8Q=wvzCf~8@4m2I942$ z9I0vKD6~!pO}Qv{(>{Gn2R=O}E6$g!LKk+Y`|m?;;CANB`sMDJ3@aI)<1C4KEa-N7n5uG?PG-V zv0oR+o`prylxm#9`atr36P%xi_RSinY{+WsbTxM63_G3Ae}_l7@DHx4IAyOlzS;n% z53N8$ujVq=mXw|w3)Tb@@ABf2!?9bPh%BJM1ia&)&d7l}L zdUcJFwYcu)Xm|Mak5$y@14%JL?sXCbckY#0vij=RUI0i2Yb#ro?E6Jk6HA3S_~Mo} z>_H*WCR3sx>lWeTIj;KAq|^rj2T6Iw_fE!+2JMu=U}#U6jnF3s|)k7y5qZ0&CH zYNfp_)pA{4%0{;8!?vcrk!0K7wR8ZIj0`1fQFo>YKEvVYV9-!Zu;=_x(lne@d*Z)CkSKR3xJp0U?@UX6zlapxYwV1LMRI9~|*HU$Xsf7jfniGjtAq(}f zQ0>8UlkE#+UamhxtwdJqf_55c^9bUE@L*mCjzlD=Hjxrmqsc%RS`w?$1AIwx)Q8&L ztS4tBBd$~4wn(F7t z7=zJ%p&5`i@;hcWU{S`YPq)*Z?r!rD@~F4*sN%DnRHi~|&6jBTgW0Bt^_;huqmHeV zXQ5gPQSjCqcf|}B0gi?mQu4U+KI_F(P;|dj0~CgatfZUQSO--W|wqJ|0Z>>jCmdgj07V?snx@C8p1d zqEi1BTRne~(5v|6y3{pId#N%cr*YRQtaYCSJ4_9qIN9F98r0eXG%j61~OTD+4|v52D$WkSihQsFfsCF$;^JOHQ&j6o}h& z*{Wor)lIf9ZT&3_s*S93_cb|`(10&viaWN`rZ}51on{(AyWEcNUuEJ z4(6##-b47tY0(^Cmpl6|4Vj&1!!gL+^|v#5zox;PzrQ7A`YpE7a6NJ)aG_~hnm3OF z7aH&U0y2bD43+)iGCDg$I}Y6b_ltAo;%eu7Al)5Ti|?Qr>_ws$m>_c#a;pRy4FUbi zrN_2NSi$2{!@g-UJN zTEvW5G_W4GuBLFmGicUoyZ#~=@Mo;{XyTK;zUjOldYhu^e#`Pnxbi&*k(CI`2E!!_ zQ|md8o>2Hwc#gyiz_SnC3+$Fbb|7g{821hqPzrhzQ`d^W_%jT>BO1n%EmG>%XcK8k zgvKOnJt=PAJhd+n<76QfLiWj9_SRYsPu49tP#Q|0eqr{7 z-q31HxrK3oFZ;8N3j3IvA1^_Bq`~_nO*CR{8%KtlAF+}yU`ZzFJvhu*jq3R0c3IE6 zqL4QNisVy36D_4-oXjy0fXf`$9aW$wwfdfd!=leO0GEWZG798aJg_`|*tuwW_@_W> NR}cSL5Ad@5e*l!)0_p$& literal 0 HcmV?d00001 diff --git a/docs/_themes/kr/layout.html b/docs/_themes/kr/layout.html index 0907a52..c7b9264 100755 --- a/docs/_themes/kr/layout.html +++ b/docs/_themes/kr/layout.html @@ -7,13 +7,25 @@ {% endif %} {% endblock %} -{%- block relbar2 %}{% endblock %} + +{% block sidebarlogo %} + +{% endblock %} + +{% block sidebar2 %} + {{ sidebar() }} + +{% endblock %} + {%- block footer %} - - Fork me on GitHub +
+ +
+
+ Fork me on GitHub diff --git a/docs/_themes/kr/static/flasky.css_t b/docs/_themes/kr/static/flasky.css_t index dcadc82..363963e 100755 --- a/docs/_themes/kr/static/flasky.css_t +++ b/docs/_themes/kr/static/flasky.css_t @@ -16,7 +16,7 @@ body { font-family: "Georgia", "Open Sans", OpenSansRegular, sans-serif; font-size: 16px; - background-color: white; + background: #fff; font-weight: 400; color: #000; margin: 0; @@ -100,7 +100,7 @@ div.sphinxsidebarwrapper p.logo { div.sphinxsidebar h3, div.sphinxsidebar h4 { font-family: 'Antic Slab' ,'Garamond', 'Georgia', serif; - color: #444; + color: #000; font-size: 24px; font-weight: normal; margin: 0 0 5px 0; @@ -112,7 +112,7 @@ div.sphinxsidebar h4 { } div.sphinxsidebar h3 a { - color: #444; + color: #000; } div.sphinxsidebar p.logo a, @@ -157,11 +157,12 @@ div.body h3, div.body h4, div.body h5, div.body h6 { - font-family: 'Antic Slab', "Open Sans", OpenSansRegular, sans-serif; + font-family: 'Antic Slab', serif; font-weight: normal; margin: 30px 0px 10px 0px; padding: 0; text-shadow: 1px 1px 3px #ddd; + color: #000; } div.body h1 { margin-top: 0; padding-top: 0; font-size: 250%; } @@ -248,7 +249,7 @@ p.admonition-title:after { pre { font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; - font-size: 0.8em; + font-size: 0.88em; } tt { @@ -541,4 +542,9 @@ a:hover tt { .revsys-inline { display: none!important; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 140px; + padding: 4px 3px; } \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 7e17d1b..c299880 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -152,7 +152,7 @@ html_static_path = ['_static'] #html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True diff --git a/docs/index.rst b/docs/index.rst index a24d8c4..478b0d7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -dataset: databases for humans -============================= +dataset: databases for busy nerds +================================= Getting the databases out of your data's way:: @@ -13,7 +13,8 @@ Getting the databases out of your data's way:: db = dataset.connect('sqlite:///weather.db') db['temperature'].find() -Features include: +Features +-------- * **Automatic schema**. If a table or column is written that does not exist in the database, it will be created automatically. @@ -22,20 +23,12 @@ Features include: * **Query helpers** for simple queries such as all rows in a table or all distinct values across a set of columns. +Contents +-------- + .. toctree:: :maxdepth: 2 -Next steps: - -* Quickstart: `Learn how to use dataset in five minutes `_ -* API: `Browse the complete API docs `_ - - - -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + quickstart + api diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 8623841..c9aba63 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -3,9 +3,6 @@ Quickstart ========== -.. toctree:: - :maxdepth: 2 - Hi, welcome to the five-minute quick-start tutorial. At first you need to import the dataset package :) ::