From 0939d6fcdb99838ed0860f87dcae5b2fd6d1f524 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Fri, 18 Jan 2013 23:17:11 +0100 Subject: [PATCH] New doc design "sphinx13". --- doc/_static/pocoo.png | Bin 4211 -> 2191 bytes doc/_templates/index.html | 26 +- doc/_templates/indexsidebar.html | 15 +- doc/_templates/layout.html | 23 -- doc/_themes/sphinx13/layout.html | 78 ++++ doc/_themes/sphinx13/static/bodybg.png | Bin 0 -> 602 bytes doc/_themes/sphinx13/static/footerbg.png | Bin 0 -> 313 bytes doc/_themes/sphinx13/static/headerbg.png | Bin 0 -> 344 bytes doc/_themes/sphinx13/static/listitem.png | Bin 0 -> 207 bytes doc/_themes/sphinx13/static/relbg.png | Bin 0 -> 332 bytes doc/_themes/sphinx13/static/sphinx13.css | 396 +++++++++++++++++++ doc/_themes/sphinx13/static/sphinxheader.png | Bin 0 -> 16255 bytes doc/_themes/sphinx13/theme.conf | 4 + doc/conf.py | 3 +- doc/develop.rst | 103 +++++ doc/install.rst | 15 + 16 files changed, 613 insertions(+), 50 deletions(-) delete mode 100644 doc/_templates/layout.html create mode 100644 doc/_themes/sphinx13/layout.html create mode 100644 doc/_themes/sphinx13/static/bodybg.png create mode 100644 doc/_themes/sphinx13/static/footerbg.png create mode 100644 doc/_themes/sphinx13/static/headerbg.png create mode 100644 doc/_themes/sphinx13/static/listitem.png create mode 100644 doc/_themes/sphinx13/static/relbg.png create mode 100644 doc/_themes/sphinx13/static/sphinx13.css create mode 100644 doc/_themes/sphinx13/static/sphinxheader.png create mode 100644 doc/_themes/sphinx13/theme.conf create mode 100644 doc/develop.rst create mode 100644 doc/install.rst diff --git a/doc/_static/pocoo.png b/doc/_static/pocoo.png index 297dcd5e068fcbba3bf21c27d485dcf0e0bf775a..eeb18eafe2c19c03d2ee7c7a6744e7d7af009bc3 100644 GIT binary patch delta 2186 zcmV;52zB@KAde9tiBL{Q4GJ0x0000DNk~Le0000=0000#2nGNE07pMw1Cc-;f87BP z1~Cn@Y}~^D00=HgL_t(|+U=WrlvPz7$3Mdi;A4QIc2O#Wx+qaW%zVHqi;_?v5w|*$ z5)0EzSF3WZP~5~4MYgYeR4d^RVqv-xggruLh7?*pNG%x?v0w@il*bMSkw*-V>5uz8 zak}d=z@0mf3-`CytaI*p{LVh#fAf2Mf4{v4N>Y-Nw1Jeh*MS-9x&UtjX9DFh`1Nf$ zo(}E!BMt(N15O7P3%C+cIphssFVG0=2JR`j-u~Th6Ywxl3(N&R6N6t-vZ#Fkl^N^K z1iAr3V(u|(dl(DWea5XRt7@0bCp{(j{V57iWeMACftotJHe+QsK<9Z%g z3VaDT4LBC)0jvZXfYV~|bw`xz8S91si-3;6Lx2Hp2aW-{YMgUo@T-76zy@H2vF@8k zj71si1_RIP=Lp~f;7MSeT17)o12fU`AmjRyu zZUF8Eb^+UC@C%J~7MKone*sJkzTQ|@20RU11pE;g8H2AsTwQN2&P)d}@}CHR{-HiepQRb;q>}i!#=Y0cHZ{#^7IVrZvp~#saei$UlI7z$?JX zz^WMhiCOnNu55UA4F1j3@gD&90c(K)Em7_qszu$WZ1j?`u75K?fBGsgMj7l|z!ku+ zfbGCXfH}Zw4z-+;MvLO)>awz;Iwu z41Nbt6@$Mb2EQTurWpKM?T*ZG?n&TApbA)|fZt|7EdZtf*X!%QWvsjO5UuHCUFKRCI&xMuG|-x)|Nm$3LK??d$mYlFxE}YRa&SN>29oh!dQ2# z4*v*vPeC}526YM!hDtOkG5AryOTbmey76rV)LX#6flHKu28sNA2YAm|H{Muxwz2MW z3jDtTHUYa+mU0;|Ez5G2iWW2lQhBO_u^G4oe+qth=g-XL~jA0DgS{t6HuwQK|cyEft4yaSVR9 zv94AbX+5wRsEEN|XRNzJR&lx*^C^mB{bKN2rQ&E{ObmW+mg>I??8l6CU4i-1-vu}e zxLI+n5!jg`f2mE$_W=u38|$XU;Gb_bpd{~T+XHwxaiJLe8o z_yBu=>x^|P)PK5H!M#FsA+2M5Y79+%)OU?_j{>8m^VHU6=Fe#Ra18$U`?=;;)oQ=Z z8vNb^yxhG&PbG`zfEroS?@|PLOALNy`i~#o)W; zIClo{7vPZ?{IvzD2{)>vfZY97{T>Q@O2_Mg0L)DBEsS-ufNF8S5#nmC2Gm8emYNv6 z%{n(nneF@-{0jvDsiWuwq9)75lR5(b1b!x7Rjt^F82@A?oQ=R@#X5jBz-j>-)!vyU z_b)h5f0at={=UA0)sWg$RSY zB?b$mM*Ss3_ws|O2Ab1mN%+YSV_otE2WtDbe*yz_39weJmFMIxSH|EMXIb8-jddT3 z!7q)$p9OpYcpxc{QeIRhAp6JQYg@c=XRNyh_=SEBQkMECa9a%ijsm*g1YlSUeqa;V zlmU;ZFy5Y>VU2YIfG>-3%uBavTBXBjth+^wJTdDsz{cQf3JBEsq9w=Y>SC&47X-lF zf5y6-fEh9P586$KGX{T;N`)mU;0rpH6oda0umiX=2S|Mskn04}SoNm16mkp|1$vR~ z#=2#xT5M|zbYs5(EHKucsO6AElq&jKe( z|0FT?8lZa&ev&Sm3Dn2ne_rV4R}@fJe_};D)q7YgFZ-V@p=)QN16xy8-B))!HczpknY1z?&&+xI7Ov z+ttfTdPbd$br)xWR8D5y0>GLWfBcI@1(ak~YJaS;?og-0cBG2y1n^M;sH?H=C^C!6 zPSLsPtwm}J4ODt6s#l&t{V{EmqV`HHLA+U6vA6hE1DTaI#Rrt8k={s^GSzvuR1&Ld zOa<-<(m684+iHu|q5z&q?f)=O9hYWhzeM_wSzVW8yDh~G)Qjx<*Nh6ae{u8a5@fp| zWEN>8@u`MZl$HQ$E&o3Seq)|)Jetg6*0fbsrN+FV*nwJ|0;&M6@ict}K3_L=%3J z0;@wabnPV56x;@UR$S_rV66>QMGNYl2z*7Pb6qoaEhjUvut9Tm4<0VAM-2W$GE?j) z(EKU(O2w%?lw|*6tb4~;H@_{%P*EgU{TcXa$z)1Wl9H69B+Zil0;2QYq0+=tr~m)} M07*qoM6N<$f@(?jRR910 literal 4211 zcmV-(5RC7MP)Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01T4=01T4>#7OamzNA*~u5B4%i0M|m zY(1tM_3h0!C7(C8rCBOTwX>vp^Y#cEb99TM6J97pv5`^ILa_i%?l%RMt0;lM>5ui> z&T^VLb2&4d!?3>3GtbQ4v)9^duUX&qyRJ20U|?WiU|?WiP$TGIx*$LNFzODx4x9+o z1)jUc^ol_)bTnPiBEAIl1&#$~3$Y9g43SF2Yrrm`8Q1~*%yfx?QSHi8@74i#0CRyU zz^4PxU1)m7z(}Ox2-Lw3qZ5Iiz_7q`9|dLrFZ*F+`pv*dqyhxm2WSG$037YB(?u%1 z4!k4eT5fvGz!2%*N%RHaS)g9}=1;&pzy^*1_5}_GmIB*>V*<}zWO~lPs3;i{4FhHZ zoq+K`Z{TL2E6_vw>XE>6mjQ!-wZK9@jJ{!d&%j6|MWUg=({gwgun9;4Z;L8-GH{rD zKRocw*z+qzXz@W5U<^tsCd#t za;{m<{YdPnSN$;RYr51(q&-1`TnbDAP6<5sBR65atW_TGQwP!Q~PoRRMv;8pYS7tq9w$C0cmY>6*;cwrZGHz>B#wZmMKU!4|Bv##{RHKr zjwNnKlqc=Kg$(?YbwKcKT?TT|Q2*^o%3`=XW@6e3q8@dtUoBkN^JfxiOx1)h6Fh3@wb zDkB_GC%-Sp!+}HO{087rV3HPZ!VjZ|#4eZtoF%cU-8JiWl=iK6Y-?*7ie-v#LD*w&gd${vJD|5}&p*^{aC6j8ka<~X+XnKmI(LUrIGU;rv< z^IB9!bd0f0w)Mj*5$S6(lROr9?zvgtJ%aMgeKGLdSrxcfCzQJ!la*k+(ICdP_G16Mk>b#E3yuMxHNDAaP3oxl=Q=E?PrZM~P{KDUzzX8*&ntzkK? zX^?w=9rzSbhw{|E1pKdKTgzJ@^kw2$I!c~9p468Bfn!_uBva{wfj`Sc*i}4NS<+~vsA;n*aihReJo3@LXQV4)ITN6CP1Xk|0|ioV|{1LS^G zylg+s9v%!#OQzD76;b|oB6Yjx7_j|hVz?dnPi-*P$wYD`uppUAkH~SK-r9Zo=BWEf z8AD@)*md&Nfv8o>e@&*+C+8@4D3F#u|E%`hvA{S&vr+5i{#~_eI&1CPe|OtRm&^Mm zR2DVj`HFF<*cTOtc;RNq;YjVP>*W2-3g2?0s7N!!{_8Bp@_Lo0V&*AuwMjxMLTu1V_Of(=a-YI^jCppGST#q zdyFiy-ItL`6y6RrIkxqd-1lm!XCGj2GL=5wv8}&pZPF*~365>)w(%Ts8pRHee*#Zt zN#;$CZ9Ul*Ub`l3U`+VF^M$qp^lb3 zhzo(?*(8d8Pwn&jGI8o&xwpl}ig8A=c=cXa1?R*hl6p6Y-5KNadD^rMxM6p@|5`(& zSgo7eWLtA`h}jsOP|Fpl5}76f-xF2oIZZd7R|T7FupdUf@;D^=iruh4)Xvd<81>9* z>+HaDe-e1^SbZ&16|g*uL^!s!1klyT{wGxs_F0e5Ep%*a?H)m-L@IrfHlrP#NToOGFVr%JT%@ZOnSO@K-hNe6 zo0eDj9?t_?$+-G;5)Bd^dr{!IKlQ`NL*@8wrhQ?(_PN|89{NJZck^8HZVP2v!lByd zKH^-^U%CUKXP!x6bz5|7xi-?}S>BG$g=U&WD*azgw)H|4$@HNgMhnQ~!fmO-Z7u?) z`(bo6%B|f`bovv3n*-0iNk}yj__i!XZ%@#dek?1qj@6p_oX@*;K-TffBI{lzwr6bP zj&9*vJ+8D$lS+N|2qGm?>8|3@0hMK)FI&13DlMj7b2_|G<>!f2m#t!~R+_9&`(bpr zJl9P!s6yb&S{l+MU_;=!zim$pN~Y5NQF(?jmX=x7>zaBuAelzaYu=Z{2M z7lQ>Fkp=+i9Chcy8yb-YCR6GC9ot&J8_k@uB+~iXj5Myvwq~|Kx-(GQTLGMxNTsi7 zvaR>4I9|4B2Ir1y+(7oV8=l8b`Z3BaJgkj*b3g$t0y3e4Qt=EBFQn{+@@7ua2-}@Z zwg4rN0aRwpg_`PlJt{C;2+wM5YCx?s8(l=Xjk;QyOr<+IwzX?_5h?yb7K?G;5+-Ow z+E*mmJ-dNOU5ijRD+)i1PDceWUn-(ss*Tf=sq|!#n#+Lm#37>(?q|!a`yN!lHCCbT zNT$-O9ow3nOr`$=<#z9`Nu#SvsQY&)7x<}i{G((l-6*Q^5~;U8a2oKTV_P@Nb$5%# z6SwIaiIe>r6;C`66;ImFv8_zc6pkPTGBGGg*GAO=Ar_| zE65}t>v%}Mk8!g&WS*$D*DjVuJH-}g5l!j=@6%45lt`tI+YL4ne9~1~3VNb4flJ8- zo+LW@l)!VJY6m9Klc?CrD(yGkg~~5G$@%wiMX6+Z4YlU$E;63Uo*IE>0w+4QRme_k z&QbRgkt{c&GBdKV3*}x<=V;S0z;9(D$)&9<$||!Al^?k{>)Mjdf|}ZC)eoafL_Gkw zPL@QJTE__}H~J3Xkic`_D{%b?nZdRIy#mkO(H761Or__^KmvHcv8^UKe>f_q?KP)L z_NnCF9U;z_#n~~etZS2ER{=cZ*w)Yjb@xKWml{xR^%ah7Z7!lseSuGldbw8GwJXoH zb!65hZ3X6*n#EpEZDG9-pdOW#9F$Q<9LuN!B0r3-%J;`&@)s~;WoG?lTal=M^jO*o z4_&eMSV0jB9R+$ocWDuIZ$JgQOKsC?ii{}<@t2Uv#oH~;hW3mNLZmuTJ<5ST6MY5v zDk^0r7lxu@NZYbhSOY#@50nu5WCd!i+L78NkJrkx)*6x436WZ}Bw^XaeT}dd-4);>{PoaqvrnBMV2_6Du-hN&%Le0@?B&g4$=DPtiW?0 z*RH8UWoeuOtPDK29|n89=&d#A+k$z17?q^H%62=l-au5`WIJkq0s}*&+JbD8^_m=Z&1d5jsN;D} zDm814g&U;KSij$bik=%7BGn`w);@o?%sS4=V@D1`{W~8hZ{21yj0|d(NNH3mNi$II zhf&E(k0r}HTg3zAg^KN?$IK8isAVFp;*(npUsa}>cnRvymUXGrsP)@)GlUFknMlhu zA~gfu{4nZYCYeT%dl#f#viXXEL2VLAb}XH&Ns>;$L9M8A99p1Pu+j`4gIbqJp!U{_ zodxkfN|cMgpw_MED&7V&d<<%yNa63}FsQkt)ok2| z+J5&~G8?3qi#Ji*O05k%cN1#gYXgItSM3Nq_kGlkoQKi+EsVQ~owU;o8v}zf;fK)* zKa8fDo-o)ORl7>!&*a~9-oU`Xz`(%3z`(%3z`(%3z`&q#_!s|3Isbm4mS_L~002ov JPDHLkV1n-_3t9jG diff --git a/doc/_templates/index.html b/doc/_templates/index.html index 34dead7e6..cd6c535ca 100644 --- a/doc/_templates/index.html +++ b/doc/_templates/index.html @@ -17,25 +17,23 @@ documentation of Python projects, but C/C++ is already supported as well, and it is planned to add special support for other languages as well. Of course, this site is also created from reStructuredText sources using - Sphinx! -

-

- Sphinx is under constant development. The following features are present, - work fine and can be seen “in action” in the Python docs: + Sphinx! The following features should be highlighted:

  • Output formats: HTML (including Windows HTML Help), LaTeX (for - printable PDF versions), manual pages, plain text
    • + printable PDF versions), Texinfo, manual pages, plain text
  • Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information
  • Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
    • -
  • Automatic indices: general index as well as a module index
    • +
  • Automatic indices: general index as well as a language-specific + module indices
  • Code handling: automatic highlighting using the Pygments highlighter
  • Extensions: automatic testing of code snippets, inclusion of - docstrings from Python modules (API docs), and more
    • + docstrings from Python modules (API docs), and + more

Sphinx uses reStructuredText @@ -44,7 +42,7 @@ suite, the Docutils.

-

Documentation

+

Documentation

@@ -86,14 +84,4 @@

There is a Japanese translation of this documentation, thanks to Yoshiki Shibukawa.

-

Get Sphinx

-

- Sphinx is available as an easy-installable - package on the Python Package - Index. -

-

The code can be found in a Mercurial repository, at - http://bitbucket.org/birkenfeld/sphinx/.

- {% endblock %} diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html index feafd9046..ee8ff0182 100644 --- a/doc/_templates/indexsidebar.html +++ b/doc/_templates/indexsidebar.html @@ -1,5 +1,5 @@ - +

Download

{% if version.endswith('(hg)') %} @@ -20,11 +20,12 @@ are also available.

Questions? Suggestions?

-

Join the Google group:

-
- - +

Join the Google group:

+ + +

or come to the #pocoo channel on FreeNode.

You can also open an issue at the diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html deleted file mode 100644 index 6e609e1a1..000000000 --- a/doc/_templates/layout.html +++ /dev/null @@ -1,23 +0,0 @@ -{% extends "!layout.html" %} - -{% block extrahead %} -{{ super() }} -{%- if not embedded %} - -{%- endif %} -{% endblock %} - -{% block rootrellink %} -

  • Sphinx home | 
    • -
  • Documentation - »
    • -{% endblock %} - -{% block header %} -
    -Sphinx logo -
    -{% endblock %} diff --git a/doc/_themes/sphinx13/layout.html b/doc/_themes/sphinx13/layout.html new file mode 100644 index 000000000..69dd37f77 --- /dev/null +++ b/doc/_themes/sphinx13/layout.html @@ -0,0 +1,78 @@ +{# + sphinxdoc/layout.html + ~~~~~~~~~~~~~~~~~~~~~ + + Sphinx layout template for the sphinxdoc theme. + + :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{%- extends "basic/layout.html" %} + +{# put the sidebar before the body #} +{% block sidebar1 %}{{ sidebar() }}{% endblock %} +{% block sidebar2 %}{% endblock %} + +{% block extrahead %} + +{{ super() }} +{%- if not embedded %} + + +{%- endif %} +{% endblock %} + +{% block rootrellink %} +
  • Sphinx home |
    • +
  • Documentation »
    • +{% endblock %} + +{% block header %} +
    + +
    + + SPHINX + +
    +
    +{% endblock %} diff --git a/doc/_themes/sphinx13/static/bodybg.png b/doc/_themes/sphinx13/static/bodybg.png new file mode 100644 index 0000000000000000000000000000000000000000..506b6f908b346569a405118042adcb5db9fb59d3 GIT binary patch literal 602 zcmV-g0;TC1q*fe@n4#zaZ?&yk{Pg#&{Xy2CBNQ>%&e-+xAnMpv*ngq{Yp02t8n}`i8jjEKY*^cXXY{O zlvqRJrK(`I&QecRHo;4L?3|K%;w7(12#~EORd`4xJxNt{*kqnilB5|iZ0uZgjEK%b z)w#xbjxj=-QrK73Rh1C!4>V|(6f0;o2uL%Q41W4Pp2U|b-=$hM*L7d-=F90}_z(Ex oiKLl%?=@rxd|N}U-+$K7UroZ0lrV;)AOHXW07*qoM6N<$f)b?!!T zStD}VgsY}*S8{)cY|s5E@lW=1_Qve`>w9F9_U3-h-^Tn*!*t`hZ6H=!O@QAMW#`%r zQCFfiu$_5aXm50deYNXb(KUjbU-QI1fB!%6&(p&{7=;g?6nRsmascQ@22WQ%mvv4F FO#mA*ghBuS literal 0 HcmV?d00001 diff --git a/doc/_themes/sphinx13/static/headerbg.png b/doc/_themes/sphinx13/static/headerbg.png new file mode 100644 index 0000000000000000000000000000000000000000..6d3e1d5e651326bf0315d05da96aedfe55b257e9 GIT binary patch literal 344 zcmeAS@N?(olHy`uVBq!ia0vp^A|TAc1SFYWcSQjy&H|6fVxatW5N34Jm|X!BWH0gb zb!ETH$S0;{@^ZgSFHq>ar;B5V#p$<`9rF$=2)N#FFBB1xU)}!l@6!$qvzdB6oSg4g z1%;<3&V0zZSF*O`-;aJU@DxD`=Le`hnB0DjDSsgXeG@Jbi4RlYsDn#}C*1 z?qBrQJ%5Jg**LTF;RO>exn4YA8($uBaf;poL1O_1zPS9gqH)^nGivj%)c)Oiq9Fh1 zna@rfUel{~-Thm~ykWB6^IJ9huGz&Ke%{pOdGVFR`|Vb5FYol5ef2b(T~h7&l5JL- zYLEM5)^&Z|c6R?wz8RW+zH2t;{xi8P$o(g2=Jc;K7urSWX6Z&Sr_Gx_ZJ{2Jy(OV{ o2CwkH%oFT4{vZBvy8R>T@984ky))J?1qK0wr>mdKI;Vst0L~YZ=>Px# literal 0 HcmV?d00001 diff --git a/doc/_themes/sphinx13/static/listitem.png b/doc/_themes/sphinx13/static/listitem.png new file mode 100644 index 0000000000000000000000000000000000000000..e45715f914df0b9ce5650cd81f826565d794bc6f GIT binary patch literal 207 zcmeAS@N?(olHy`uVBq!ia0vp^oIuRO!3HEZ#7tid5-9M9ECz~A24Tjhjus6-LG}_) zUsv|KjDqY+yxD&zFaw41JY5_^BrYc>NGv&UGh(5%v^3ic2_Tqf;9+ScrKuZn^uU2H zQyfn*9&-yU`CQ%jRM<_jbEVs=+4%-On`#az=vrO%C^ha<()jUzeq*EHImaYp10cwd vh@M+!5EQwitFh7Z?ulO_J-(9;uViOPP?5c=x_{|>pv?@Pu6{1-oD!M<&SgTz literal 0 HcmV?d00001 diff --git a/doc/_themes/sphinx13/static/relbg.png b/doc/_themes/sphinx13/static/relbg.png new file mode 100644 index 0000000000000000000000000000000000000000..47225851b87028b3b18e4ca7e0162984a3643595 GIT binary patch literal 332 zcmeAS@N?(olHy`uVBq!ia0vp^A|TAc1SFYWcSQjy&H|6fVxatW5N34Jm|X!BWH0gb zb!ETH$S>#XorPwP2Z@rO!1+&>XXC$7MK3nOVpPe b)G_S-&Gh)gjM8kNw;4QL{an^LB{Ts5zWs(2 literal 0 HcmV?d00001 diff --git a/doc/_themes/sphinx13/static/sphinx13.css b/doc/_themes/sphinx13/static/sphinx13.css new file mode 100644 index 000000000..bb81b67b5 --- /dev/null +++ b/doc/_themes/sphinx13/static/sphinx13.css @@ -0,0 +1,396 @@ +/* + * sphinx13.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- sphinx13 theme. + * + * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 14px; + text-align: center; + background-image: url(bodybg.png); + color: black; + padding: 0; + border-right: 1px solid #0a507a; + border-left: 1px solid #0a507a; + + margin: 0 auto; + min-width: 780px; + max-width: 1080px; +} + +.pageheader { + background-image: url(headerbg.png); + text-align: left; + padding: 10px 15px; +} + +.pageheader ul { + float: right; + color: white; + list-style-type: none; + padding-left: 0; + margin-top: 30px; + margin-right: 10px; +} + +.pageheader li { + float: left; + margin: 0 0 0 10px; +} + +.pageheader li a { + border-radius: 1px; + padding: 8px 12px; + color: #f9f9f0; + text-shadow: 0 0 5px rgba(0, 0, 0, 0.5); +} + +.pageheader li a:hover { + background-color: #f9f9f0; + color: #0a507a; + text-shadow: none; +} + +div.document { + background-color: white; + text-align: left; +} + +div.bodywrapper { + margin: 0 240px 0 0; + border-right: 1px solid #0a507a; +} + +div.body { + margin: 0; + padding: 0.5em 20px 20px 20px; +} + +div.related { + font-size: 1em; + color: white; +} + +div.related ul { + background-image: url(relbg.png); + height: 1.9em; + border-top: 1px solid #002e50; + border-bottom: 1px solid #002e50; +} + +div.related ul li { + margin: 0 5px 0 0; + padding: 0; + float: left; +} + +div.related ul li.right { + float: right; + margin-right: 5px; +} + +div.related ul li a { + margin: 0; + padding: 0 5px 0 5px; + line-height: 1.75em; + color: #f9f9f0; + text-shadow: 0px 0px 1px rgba(0, 0, 0, 0.5); +} + +div.related ul li a:hover { + color: white; + /*text-decoration: underline;*/ + text-shadow: 0px 0px 1px rgba(255, 255, 255, 0.5); +} + +div.sphinxsidebarwrapper { + position: relative; + top: 0px; + padding: 0; +} + +div.sphinxsidebar { + margin: 0; + padding: 0 15px 15px 0; + width: 210px; + float: right; + font-size: 1em; + text-align: left; +} + +div.sphinxsidebar .logo { + font-size: 1.8em; + color: #0A507A; + font-weight: 300; + text-align: center; +} + +div.sphinxsidebar .logo img { + vertical-align: middle; +} + +div.sphinxsidebar input { + border: 1px solid #aaa; + font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 1em; +} + +div.sphinxsidebar h3 { + font-size: 1.5em; + border-top: 1px solid #0a507a; + margin-top: 1em; + margin-bottom: 0.5em; + padding-top: 0.5em; +} + +div.sphinxsidebar h4 { + font-size: 1.2em; + margin-bottom: 0; +} + +div.sphinxsidebar h3, div.sphinxsidebar h4 { + margin-right: -15px; + margin-left: -15px; + padding-right: 14px; + padding-left: 14px; + color: #333; + font-weight: 300; + /*text-shadow: 0px 0px 0.5px rgba(0, 0, 0, 0.4);*/ +} + +div.sphinxsidebarwrapper > h3:first-child { + margin-top: 0.5em; + border: none; +} + +div.sphinxsidebar h3 a { + color: #333; +} + +div.sphinxsidebar ul { + color: #444; + margin-top: 7px; + padding: 0; + line-height: 130%; +} + +div.sphinxsidebar ul ul { + margin-left: 20px; + list-style-image: url(listitem.png); +} + +div.footer { + background-image: url(footerbg.png); + color: #ccc; + text-shadow: 0 0 .2px rgba(255, 255, 255, 0.8); + padding: 3px 8px 3px 0; + clear: both; + font-size: 0.8em; + text-align: right; +} + +/* no need to make a visible link to Sphinx on the Sphinx page */ +div.footer a { + color: #ccc; +} + +/* -- body styles ----------------------------------------------------------- */ + +p { + margin: 0.8em 0 0.5em 0; +} + +a { + color: #A2881D; + text-decoration: none; +} + +a:hover { + color: #E1C13F; +} + +div.body a { + text-decoration: underline; +} + +h1 { + margin: 10px 0 0 0; + font-size: 2.4em; + color: #0A507A; + font-weight: 300; +} + +h2 { + margin: 1.em 0 0.2em 0; + font-size: 1.5em; + font-weight: 300; + padding: 0; + color: #174967; +} + +h3 { + margin: 1em 0 -0.3em 0; + font-size: 1.3em; + font-weight: 300; +} + +div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a { + text-decoration: none; +} + +div.body h1 a tt, div.body h2 a tt, div.body h3 a tt, div.body h4 a tt, div.body h5 a tt, div.body h6 a tt { + color: #0A507A !important; + font-size: inherit !important; +} + +a.headerlink { + color: #0A507A !important; + font-size: 12px; + margin-left: 6px; + padding: 0 4px 0 4px; + text-decoration: none !important; + float: right; +} + +a.headerlink:hover { + background-color: #ccc; + color: white!important; +} + +cite, code, tt { + font-family: 'Consolas', 'DejaVu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 14px; + letter-spacing: -0.02em; +} + +tt { + background-color: #f2f2f2; + border: 1px solid #ddd; + border-radius: 2px; + color: #333; + padding: 1px; +} + +tt.descname, tt.descclassname, tt.xref { + border: 0; +} + +hr { + border: 1px solid #abc; + margin: 2em; +} + +a tt { + border: 0; + color: #a2881d; +} + +a tt:hover { + color: #e1c13f; +} + +pre { + font-family: 'Consolas', 'DejaVu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 13px; + letter-spacing: 0.015em; + line-height: 120%; + padding: 0.5em; + border: 1px solid #ccc; + border-radius: 2px; + background-color: #f8f8f8; +} + +pre a { + color: inherit; + text-decoration: underline; +} + +td.linenos pre { + padding: 0.5em 0; +} + +div.quotebar { + background-color: #f8f8f8; + max-width: 250px; + float: right; + padding: 0px 7px; + border: 1px solid #ccc; + margin-left: 1em; +} + +div.topic { + background-color: #f8f8f8; +} + +table { + border-collapse: collapse; + margin: 0 -0.5em 0 -0.5em; +} + +table td, table th { + padding: 0.2em 0.5em 0.2em 0.5em; +} + +div.admonition, div.warning { + font-size: 0.9em; + margin: 1em 0 1em 0; + border: 1px solid #86989B; + border-radius: 2px; + background-color: #f7f7f7; + padding: 0; +} + +div.admonition p, div.warning p { + margin: 0.5em 1em 0.5em 1em; + padding: 0; +} + +div.admonition pre, div.warning pre { + margin: 0.4em 1em 0.4em 1em; +} + +div.admonition p.admonition-title, +div.warning p.admonition-title { + margin-top: 1em; + padding-top: 0.5em; + font-weight: bold; +} + +div.warning { + border: 1px solid #940000; +/* background-color: #FFCCCF;*/ +} + +div.warning p.admonition-title { +} + +div.admonition ul, div.admonition ol, +div.warning ul, div.warning ol { + margin: 0.1em 0.5em 0.5em 3em; + padding: 0; +} + +.viewcode-back { + font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} diff --git a/doc/_themes/sphinx13/static/sphinxheader.png b/doc/_themes/sphinx13/static/sphinxheader.png new file mode 100644 index 0000000000000000000000000000000000000000..2b33f09d9f291b8fa9f70d9ea7566d69d462ce50 GIT binary patch literal 16255 zcmbVzWmHvd7wx9IyQI63MnI8}?r!PsPDud)=?+1H%{AwIB9s)Q(2$9d0RTXg{vxgd08nAzXIVse@Vo0b3L)?Z{8w2iap3L0uiW;c z1n>!x;}>lg0BHL0-y3T5wv`=xh~O$MFM+TIg^kMzvlXDA3;+~>wD>1A&*f8n4^Q0w zr?=5FgP{UVvA~dZII)Dh>loacZ!%bzcoIqv5&r#QaLQQ9SP~L~GC0cK=U9cQi+v9h263ogX3OoCPXeERAuZRKruhV9xLU_!Mk*i>{O3{qAQN2#xsk=}5oVEPO z-@k3Vo)-)}KoS4xe_e3G;DS${QzDhJ4DaPk#~jVKYI(aUBSrXWeYa-cm_ig?SYc&l zRmN+#9FL8SZToc5OG}miU&p_I@STxAaXe*O^HE$d ztntYNy$^pOF$Ph1EKCjAvYksH3VcG0^R!8bixX)7 z9B!WhRn6n)@I%s!K0P^`8dk*M&`eQIE_1TZ;td8UpYs|gGe*V3qh%!u^9s!?b|RGu zvPx$-+l3!;Vw=H55CdA*N?ZiVXo=({!8 z@u4!-_Z0|&Q_|A^-fX7wAXMijf6@rpd>y7W4J-H&yVTZ1Qc^77|L%QCu}rszRE#CF zt~4rUe=vC;cm+h3ex^Tix0S??qMNl;Lz_Du>EKSA4Rvn*kX4wr6r!Z;kZM|?{(tEa1II8-w>-Y>JVituZ&U)zoK`D+#6_b(-cB>HGhMC1}R zLj19_)JSg*rtD;ABYKDxAWtt7p8@wktk&GJ5AUB_+gXNc{ASz ze{V?y&z@t)BFD?wyn(4o)cH0%>1B}GUI{+_eM`Q+r! z0#42;`oS2og1O@)r2hW2bG;VV7FBhE=>9xAj|@X!J~VlO$UK@M)X$=-Y2Lb;KV=G{ zgMxw#4rd`9s^Bbb02i&QCRP9JF|jW<6B%Q3Hfl_EdV$@>Z_RN&%9~9ICUG)EIdt;G zV?I04dBDM?8s%uKHE?FJ6>*377E6I_%bu<-DYA)%r0un6I>5|Uxz2nYzFv&!Tl-FoB+ zYxeB>{D}ft?r0xTLogMza=W?Zr6#%OpabRUQ0$R&Eu7%aQ9A%;)tcLytpr( zx)0v}Q*3j&*xd31;sLEQbJh5idh_S)sHz;_w-*cyXpRM`H(8m);ndXmDyT(O)foje zIU088MW*t>R%;fXEQ`7&H9aMzXX6|Zn1FeRYjUZ5*v%Ju@0+8f7xIAT8ewcC>Z^In z<9V_ik(cXhT7bLpsBY-@nY8k(wAlCA5pOekxzwiZi>-VDAQM_i4@Z?mwLaxDHEjqi zF{-2(;`brb|8}SjmY5q2tT18NyDx|labG-*6L;?Qug)=Zb!`9gW{eHjYUrAqo1bM1 zKjDbH`97EhcN;-F-0>lkqj(-fw#ug>GNqFSLI-aAAevbgeLTEB({CLZ7~XRZRbz_7 z7DIaCFJZc);){teP7MQy*MlqtRUOOV3uyH?e-gc!w_I)FyfW~yTQ4Y(?ObI&u`pOa=)n~G ztKlFA1>m#4x(;sjN+ke#@VVk>FYM~e9Hi)jMq$Rc_YV)w!1t=EsxE+^@<-yTQFuv~ zrGfIVnJf`MI^(C?tca2l$gpe*TN#)qhysZ}ZcP`+(!e0x+Tf6q&MN=9u@cJJwh_kKJUO*G#ebSUT^`-Q8WM zc5RK;{E-6*W?;!FH$&{MAbi2R`TB9$Q#vr(u~wmY^*g>sWhYdit$Kr~l{JycigyQtC!j zLXPK^-Q9Zwa9y%CmuTqXIv$TkMq)?>61^WT=S&rQ27S)kr3fWEvh#{99WWkuVug!D z9!w!tz(3&9hPqG9ikXFZgq#d>^UWgb^e5@LiKFm_5eKoXtnA2m_6xJuQf(ExUVFM4 z{6{`VBhi_~8jQHJwN_rssXQ;mfPgmxm6G2{7BjemNEa3)ClM&3tsDODU$9di#2{)T9!?EYzZ!;0SFExlJbt5UB5&J ze|WjZa5%+0>O{kTUfRKq*wvgkD(=4=<70mFJ;;)<5Qt%hA+J$_Uzau;7{iiCw0V#B zhr{rj{VNazkMVBNdiSp}**o8A#RK=#<$CZ~)Vdw>o(9}5E$ITJ&`MeaChegQ+h~B4 za{CuT;y~1oi{Oe6Ok}@2LpSRk?JQN=6o3Ez{oS6cAp64XZ<_RYYY&IIw0eG0-qxI) z97DIWB9#)1!9hbWo9n}WPT8YPH`4SAB0^x_;WPNEMBb5-p70#*EY~OE=(pZ_t5h@a zzb;ALWMCt`)HH4s78F?Y58N79HLmOceMsj}n&&^dH#W{Emd|3LKi@ymX;vA?KHcw3 z+=9oLMKOQM8c=I{xy^WeZ!SkhijU8mS;z=SDK3fFJQbo$Rs`ojzwP0L2|W(kEhin+ z)=qBMQc-F7rQf=k)kB9xkua1O92`t6dNrC@`QAbyW3tI9-;%O1Z$1XQ0|Qn*qk+gk zMa8>?tG=dzgIIlqDC{4@ueQtKW1Ef__cuBwHTKqA+<=jho#LZD#b z=KeEuvNVCF)$yExo28IK@rB)uYn;hmGTpiZ6Zifv<3_zrfallkzQK;0`HN5j1AmK~ zBexAGrMcY#9HP&s=W7+Z=T#j~XU9+Bs6-!T2c_t$j)b!mid0L~PWkHnUA%=!`|P} z!m2dduf@>t0k9fnJl#ed*$gZ!f{ms_)14rE>4rvZeS3YkRw$qGp;)sjJ4?6TdOh8k zCO(~RvzgFDMP;~PanS(hNGATa9IyBagi_l>as*gdFKqYxSKP)kl@(SYO?K61#Gxu2 zX>$>ff^0qw=#OzZIStHIR9}A&hq@bYqIKknX zRe_LRxT1_p`^3iy|LJ|(WSM5HIl1q}nQXhyhUgcnI5mOlo-Ic$Ss9sy*V`2b^0wP$ zT?v4+F@h5aG`&09C_;O;dhX+(f!Mlc|8$s7J0tpfUzY{^C@3h{f`XERmY9k&SYFBT z+HWRruwC+pZ>ww0WgBg9!!Eg0ln*?BLk|yz=}H1qNTb7s*X?N|K~|j>i)6E2;qgji ztgyhtWhxl-M9>3E#BrL@wtU2^ucU<#5M+hILtrPgJ74La?{|hrh=?Gv7GvoyM%_V; zF%Z{B4gk&2%WNEGrcnOf9GGr2dUjR7q*RbY+U0~EKC=YwR1GkiLx>0n0svnPv#j8} zV#HXSaSrTeJ^NZMme9>Q)#IMCVI> zr9vIE)XGuCai9^4bBBH}?SjwUU2R5L`W!Bj$l-ncUBsc|;Zb(2#SP+D_7VDNIZ)ymS{RQ{md7rEy$%?w_7BvYB1`VDGAO7~ z^ZycF$J=X>ux^8GEW)`hna6hNRt{@Q+no%BS&(s?b z*V@nF=;r9;>uVkI85&u;&N<1bz2YsYPzSYDYSB=0P3F_0$h2N2Se2gCViYMOUxi!` zo3?g`K5LZCC4c43cop=yeQrR)q4RIHU0OJPe)iS9J-#z)ov+a4wOnu0)|x4tLhI@6 z4Km|O%fwm5)+ie*oU^|1@`5WZFSk`UFv#YmrIp7aAgIE|Z(@EZ8|PCjN_aoR-7Kwh zeWQMFyVhd-oXQz{R#Ihwa`$H=I0Ic%qfl@uPr@aZ00#Q`rHkHS3e$;x3zu7eVU=kdOP*?P-hJ9=r!1mdr?2oIO&e>@lWRsF-b{DYn=D^44)nzvWpnJe>Re23A*u~&1n*l!aKr!WIN*cT3Pzzn$o&skb`P9ncK~fPWSD( z(7!IL1ACBd@a6Pw&xku+o-Sbs7ayNk46#H5JLI)*f z@%_Eh-NXG~q3CzQ+uHfccHp$zfN8kyv@b$csPp-f1m*sxR?34o;EOdKJ|jXLf^8j`1v^6v~hg23$Rw zF786B>5#lH)Pa$C4A>INYBUncp8#JZO8*ed;Vs8QD1`$@ev}H0W7@hUU;mu}9-np3 zogL)W;3**_Bu3hH@0)8+`Ck_|c>C$tcl)i-=%0jms>}KfC0i2KaDzb z`4wB{1O%4BLdfYd!(m)#Yi9>%yF@vIx55YNaPO4v;Q>wphfZ!4d7U&f zl9;AuZ8^pnB~!$Y=CUVLR@nc^PLnxFhP9-)*a!s~`35?i>*n|_@MT6(^k}KYt&EZ@ z?GGd6A9BN^Z3hu09G?%|>CR)>!U*GFr`RfUbHA)~_~|YsvyyC>6Sn9qwc?}LAfeh` zWP|CoMZF9^lG8-8-s^S=f)O4b&Q~4-zdcX_IA*S$%{pbOn(<~#9N&c9UpmWcNK0FB z_D<^MOGc;vHLbk}1UeNuIy!{aOE1^P((7MPef1Md`Mqr5l9=9vK%jDP_Px@uZU;K@u=2OL0XGNQ}2S+?uKUxZQSYbut2RoKR8tC z)@(nSY-Wu$7l+Frt8>w&$sH9jMjFT>W&%>14L44t9>FyFb7)D_ARXnncR zyC**_ZHeg<&n%)|HEdh(ENa(srBS)HSIS#-ur+hL#tJK zOd9{cns?`&osJp_bkP||#3-7f;=;~5qV39`*zS;Y+8+ zTBT+xHSR2ZHX2DLlhP=^fBkUJaUnLV>XpUB31631@bZicd|b=ilPfLvYBK%z`*-3G z9C`%<5Lh}sg3%Qj_DPHPp5vqNYntEFU6hKRo(?Y7RF|akPqknyCmFM}Wr*u?D8aH> zk8!BQAt}1lzk%pZ8r#+Tk@Hwl5#z}aq@Dk^hUHJN?CRXyDGptE5+upuFn;b^Ff_cc zlPQ?~mF(tG3Orpy*gHVfb9W~pF5b63G`CTqdlE&$Th8Y72!R;pzk6Y-@2@c#w2Tnv zT3NXP>m#!~`yLk={bkz0LURw5v+1_{Wa^Gjj zBb1sPZSlwS_3JCR31;EF`^~9&{X^N)eju4uh*v(7f3JRWa==8RQmiv;+eRvC9szU)cNF@?ol>TwAn;R2&}MsnR~48?Zrd}wI@ ze%Hr<7PsU1*I@V?hYz-klZ*CiEv^+TLtxqP&JWP#_#8ZUmpp%REZeDElf@l17s_Wxhs?Zb> zNC)xBzh^F;PA;@M>L`Rc=93P^^l|MEuXJ6NoVB?H&%Ffhkor@ra1hmfC$Vo~4Us z4iL?m+}sQ-gMZngN=z|ZrE~A{E6r6U^+5rgX`}mw0c-BA|F$Q_t?Kav6NZXGLS9mj zU2br#Fy#|Mm+N+4Ngf!*$e=KhC~$pyl1Ud5PEUHm`)@K)>Z%d-11f+M8QNndCiU48 zRSVN7d{*>yzVrUq^Ny!^s!*}5^Aa315=mZYOm#FmeOhrzN%87(cfXqeZJq+Vg-TIH zGO$R7@f~f_Ue$fWyB9(bV@s*=$b(@@D*YucW>-}XeHpF9fD1+LcfCH0LqGn5je+6s zK$fe>itRjU{#4>GrTahS_LS|%*zci0I#)?0GLJYUEUb;w?=g{&PBA;tu5L+zFuE`S zER~8{JOU_S7P9&bTK_m~bl*!x>)Zw$SHLNHK&DGHJw3IWW+38DP7&tk>oANYytWEB zG;RDBQ}T^8xf;5py&UnVng7$ftn(hKbuxgBV= zarg?MO4OF+n3A~F8E{p5dwY$!O3=L9{rwaa)+he`Lt@MlT(f{I*GK8op={fG!lO{U z<;N!bq8O3f@BH%(wUNANFe;#6-1r?=U7qYnNNZ#*kW|fds9%mhakojHvXo(E zU)aApno~p*iT{kTZY48@$^k-?l#JJiKgwjqo*W9L8>o>{r6t>wDO{Y34r^XD*YKY?CUU{1HyX=kAA zc7UWx|6wSnFLI8ym5O5T*>YRh;2_L5W0mc~v{$4?O?&&JK)N;G`0TU<(opJ}V*= zh>}2pzO*YvLPZ5v9^hw;6o>vf%{>FVN!ZxqM*;ixSH4(5BrF5+ogrzsR=dt%^}mCr zb`kDi5fod?wF-&;otNiINJ;qcblw>t=yh36On#+Fw!6Fgg)#D$FjikjM<-0kXZCBs z-;oja)mpPBh(r|rTYqgiwy%~^GGB#i$oC_$B2|%(Go#K93)=I;B3GkV$5D|o(-z~I zFE$$;emxm{4uZp~x+Q8V^WEXS|mBnZ?^paTx&DNFI)b198=<(8vID6gw;H91U#& z?tjQwSVW{o&ge*cb1bk@&Vn;UO}yfl1_5{cmqWV{%m|B52|FN7Z#xLe1yw=p`B_iH z%nqY^b>@3Ro12^X+5R}#*sDhUkyRb1lfPD|H$Pt{OVrZT5~_gJ0}v1@ueDs(Aw*k`Rr z7<3|)mX)3GeuNNp($N_Vb>HayKwgzV=pXD82X(fVXbSE7M$0MNt;d@(bEc#tyjFKR zL!N-w*3uSpOuB?pp^pJukn|bIuK)ekfvj>`bpZg7|IZ81|p*5UZZf7M*-vgusj z%Cun(=Mu-vtZ#})b)=Gz{BVE&tf8%SU8&!y$Y$`oWOY$E@&QQpd%8`sUv1ihq`fa9 zyL7+Q9Z6>OK3RKuLZFt4$%qx?@|u@&{jTb{#L{G6#XbjdO>;RI7e&jZ4E!Q0+Ii6* zMSw;u?A;eA8J(BDN-{GNS8v02;&;|8fB#M9)1gX#!c+Mk?AGezQq(m-mO>C)6-kXfe6Oum8zx8br#S~9jmv(UwLgJ&S4u;hQ7O@ujD4ySf_`v!APmn!vzVijy6^NNQOa-KQZ z&YUlo>q!*zk{@^*g|b((q`S=ARmw(Y{9nCZ;&K8E$N`aYVHSS=rtY^_zRvT_?qF|T z5D)4wC4DJSi3ll#=xS(G^mT6X$P!a1F^vq@*485X+_Y@$Fe-tQ(jU}Jh38?F7^$GS zoRRl;M%@5F-RtFu{DvI*l>!i#gs#wS+%zBctR>xaC6!_UEMO>#7-Z0Y0_lZ8zP_bR zx+^CQ;Ho&t$;*#nrj~5+mUCiJonaR$tr}AOO7U*BuV1#UGjIPxNl(uX)26+=((#pu z%XIYE$*HK7+j26u)#97d*4^uqLx9ioJtQ2&(Ok+X33e4k!IG-8i{^Dh*#WP6nPfu# zRh7hN_U@$s`S}F!(~_Hb=_BkoO2wqFhZ)gL9Kvb;DdwmkX?-@W-e=i;0Q( z`kIRP`}=oP9&G^UdJQ_-WmA^C8FG?!23355S(~8ba{jXZfk;}K5z_8+XXtl0nQgo- zsH>%QB1qm7(#q{RW!u2OkIv}aT&^#F4hra~y&*vpKPowYNG4dVx4o@28TYaiz_ON& zW8h*@Zre+Ec`4(B#o6EN+rkHe0^{>(tmrM>wl`HJpItgA72tvOp!d5<`zL zkM$x)Z9jWw`9rN{71RXcxo-4ri8UvDlmvCn3Ry5?q#R`k@n^(;F#HU-$hOOW@JR=2 z%*cx_w17t>hXYD3nmMP& zp}Ll<3=KPlef$j}r`@!)!?nu!167S$i@T|*hwJOha0mzwh)m1+BophopGKY13#9^{ z|K(YLWuHig*$BR!&HiE)nTqNRSCL%WgN?86*YxVcIwdcx&sbEiJbx!9QbzV_vv4KC zeQfGH&R^f3x8F@kUtmRhHPxSwHGBS>E(etpev{|>niZ?%E9vB#8vQVb^)~zU-_oig zpU~vX)D?KYYRjvNDN)36v@%9!i!1lVVmej|hhsY8N|+*tp8p0z0qMw?{DZ_|lTE_p zZl9UbnMRuNFUjqE;<2amOT^j~bh4TVX7iAix|o4q{=vIKscBa$0q(mLqjy~<5S-MWUZCyRd5AxH@Ziw&oZWC8+S z0*(2#)&>UtQ$pt~%abLl6II(gI1@1ZjH3(sd$|OZc_LWEM^`ZNGy3iNivOjD>!~7t zm>lMWuu}Tsr5xYOG?*0j!2mt&e2^m?^LaXjqlW8lUJf!=S9HukHi`~c9bP5>vRdgB z7Z-=4QLcr52RaFSqgq@LTWD^W(x_cqrg>FLuGz)D{|I=!$#x+P4+`qpMtDcqHf>#B z0K<=v3!d;V?E83Z92^{$`=b`#pm;Gs;PhlerjA!>D$WDEfD*s+-N}*%=Eq*JxcigA zX`=H6;*m~SP|5fTIt8AOx4#ibOOlZ1{A_XBNsc;RaFBsI50@rL^@KYULug0Dx`Asq zctDnaZ}8#^W^5tjp1x@JR$-WD<<2?bwn$L)zc_$EG+U*l_}-nCd=u~aaxm&;yabuC zcn{)ztXOMF==FHc>hcD>3EWaVB5}az`QFLJ!1rI$8Z=*9g*j}L#7Y?E@6|%K0p?=$$`9zi2POW7rU8wcW@cwfA1%60;qe!2(H zwo$kh2=$^Pd~cMaQK3_ByZBo=;d^!UrcuD##{f~$&>V59Breo3C0vOmTlb8);adEt ze(RcQe6X<(%*;hJ0s;m1yF)V%^a`0wSoj`D_kA1%UHs?EEEZT)M=&~eLlhC>mnDtI zAa;H2L2=)`+!M_j3<+dVSWk08wvgLU;G4F=3wn3F0-|Wl48y3opj4YX;w~ z@9+MyrixJv{z44Qd(^P@7yUUDM2}qf?({UBG+&t~z7VoeX@mSmYT@p#U;z3;G?P+n zrh!a1PPpVb8Bkj*74PA`5@d?`{OOaj7|6y+Zmqi(PH&c#wmftBZ^}A6p}c7T7g&{? zVm?6u1COooM9i>ZN|YSrQC;7U%6Qc{?!U%R@}*C79Z1bWrc&R6UJ-ypgjdubB>4~A zJwDq01TlLCg*a#(e|!~ztqWWCd6=f}%TH?zpZ*>ryC?_KIblOZ1%F*5U zrWcBq*(Q|tRSiK=baWVl9>6Ew3oNM{^aSY_RQZ`QVGdYyfRRy|Nyy`@Mz5^m3zQ?2 zZ&13vQHVc!xNvk~+OW))GwC2!vRQo!n|}7qL5|Oz-@krMk238NrYpr}PC)0r^LWQV z>8Hz6)3C$J8sWg{7u0+>x_t;-HL}j|+Gw$Z$D7r+C7;U-fsnB|r~f+uth1ftg11T^ z;;!%n=bJ?jkC9LH<4jeviQ8e zx4b!xVxIKve$-yr^>RN)ey__>+U_=`s;w;iD2**wLEcI3mumXLt_8l~zega$#Z)$T zbjg^w4PR8eW`FgI!Ej@kI~SxM8UM>#7L7u~T~fHSl1JG8^G>205Wz?&Pk3|T;1LiI zU=VWnwuA0WXvcnts~qg)hMRZVNZ+oj;OR)RpC5AD``Y!UqW(NIdRS?0`S6~);7l4i z18K-o-G<^OwHaGil*325gfMI|LI*iY5fMtr>(f)!zzy*Wld&z8323+M>x5UM{b8J2 zbnbDw?9**sj~~d6qU-p4UvdD-cpGrATrWxr%Yo1Zc!Igcf?LYIX<=hW#Q(X=448ou?`>6; z{?9^t=HZ8bHXRiIw!>QFcs(uGy z43^HgIJ4r*TNKSShvyYDcyf|Kb(L$gR~mp;AKD8fno1L1<{LK-)c2FBzwszPg4q=R z{@%Bum=?6JZf~Ftx2lb2U%D=iP5uhj+3{w`N6`R6(ZhFO@11d*gccIUbgU}@8^eywVCjHbqka5Q*$-e!V;1eepDgMAZ1D+1Oq(E z1gaDZm9#|?67^c~sh&JgU7QyRUxiCSld`gB$j^+{5hn^TFy1a05)5}8d|m7_0~`7N zMq_d~Uom0Uy7sI2-_ym#1w2SqrooA*HW)+=X|pWP(3$3$a6-==k+Db8Gj)`x2b7PesgjCfud&>0`vf{drp<#nj`vzbC`c zM9Gm55j|nL5&)fVil3`^^SLrcs=U0D`}5q=<*a=U#_!r;a#8N%SMK`E{dNXTrwOkg zYwOa|G>f2rE`%s#rvf9^&GGT89{>!bjg6^)IxNJkQ^iaR5E;e21B>U4YsgHnqeqH# zXAxm@(Z<1k;V5W4?NtGKyK=g;s^-u^e}ouO^e}`j;V5-Tt+Gao+dV;A-#}T}n@&{J z1nOSLaJN%X%I%v>^Akw5sJOVOE=Wo8ruya+q6J39*mKDgF^?%IPWZO}QET>?E&c~r zY@X}_!dzT=Ref6QA?V0Fa>u08+tqXoF(y{^8LTZkgNm8CR?ASpw{PG4!E{+;u`>|8aI#eQ-WhCb zBM-iy7Y#n2JrJQgr%nk90DT=DGsMA9p25MNp>_XQ&NER_oy^e6u4h1YKF4a;Y=^Ua z-|K82H@5R9$C^LqMZ}msaXFMr2;NR)wvXf`YpkD8+{AvE4+(#KbT% zFdQM}(%zfS3zcp;EY*e*f8d|zD_EbP{S^7CG)MzhJI^k zvk+$t{bo}sLFNUWf_3e!fju^SM_=n(96^H_8*dsnUAsYAYF5^BCZGIZuP4H=X{~aR zBKh)QtA7xebBs;#dXp11SPG}FczTsz5l z(Y-MuY*u5kA;HIgv77xY*k+&c#fe3MD1FE<-u^CsBNGjw{ z)^~r<`9D$ZfwHA@rQHhKIlFf4b@iOJFw!PNpqv`#(O)4G4j}G6yJQAdyN57Sq zpQyC2Pr8j~K8yh$tN8BK#Tq+1i>w5v?He(^N6GT1#K(JQ8>hyA2G9*sT->Jdug28u zh8?~X!ot+@RB|VUrklEx4L6wnp3B$$xjWISRPo$=n z_^%Ii__yK{9Q-I{epI($qrsNW09}`R{rv^apt-oQ%AmcFlJd8r*)`lpuY4yrEAO2v zxc5Hosok_D13%94rV`ckQqJmcZk!Aju(@Lr=rL#kEx-sr@E7p)XgW+wCw*pB*ATo9 zP^zGswnc|hM!C@tJm}Q zm#m>kyMx&r0nbUvs4}RG!vSgS?` z)%qq#+re;XgXgi-T2zkCt+qeUX*5&d^fT}tw!(=pP#J*N_-3yNh3FJLI59E7lf6a4 z_xg;c*r-=8N0$L(L=}kD`PyPn3kJZDkWMyeOE7K5kL^1@y}q>GKK~nR*uZ%Ae6`RU zerG#%tiB%<^g|EG0{)hMsZ#=kKa5cV*1cgoevNi3_cz(XLVUIx9Sha!7ww_1!VA-JNy7w}$6-xGNI z5j~B*Pw2!O5GDQ?j>nvg0TS`Od`XiFQmIiHmU?Smkz|FV z%lLrsfv>wCGRk{Zoj;bh#DU)c-vz48yyrd6$l70Hun@BpWpsS>-mZSV3sd1%gWQ$ ze_j+1F6$vwE5#L!k}zRr9$|&ys1tmt*5a;gs9Re>e)-p^#T^4~i+Ej*Sxm*9G+`fe z*~XNB!YKR7^Q+70OQ;_pPN`VmSI+IvXWKV`OAqzT_#FJ{Mbu$}lUQA&+m-~n>j2+o z6Y`jC6a0&1%u;P>xzRxg!8eVBiX)Z{$Oez_jt1C4(Dpg*L6@+sp?O`_t=G0o+^M5~ zuYh-Wj2zz-F@PTxRskh%=xoDWR!N~x)|zkw8i?eMrgpv!MG*wNrppwtIq{S7L_<2K z==zDG=~Oi|+{Z`QJ0DHN#YbBwMBgsi3E1?OF^tIXF=xeQKfn71db3+3dYpluadAn) zplPvpbHoaF=bfDOdt&*pEFllF|I{IJ1a#6RkhQEd1poTl%hmO`0JQE9Z6>_2fV{@w z!UCTsXo6FQo}s0s6&U+4nldzIx`Ubdeuuny7IKg_0R?;> zcygI?I3ukV*C7gk0krVq8%Qpn60zJ*GYfVIPfc>mBU#_Eh6YCwuycusY=JWU=)+YC z8#ISz5johV?k}Yfxf~Im;dVO(1$30IO;^DvP-XlKiV|2y-m%w@d6P1u-T|=(D-Hpp z&QI&xc^St(pv(z;(j;45)l3p2~ zBYS+4>#aer`n7y0)%DWfzvgxOqh5A#Q^r z*5ChRF)kYJsRi%jE>jM_6yK@Hm#5>u(WMQCKYd0A+mMwfCDBx<$@DT;?RLwd!pP+TS zVutx}oQy?XHH!wW1IsAH01OZsN`#`VF;b%TkpAaSU%j>4mLgq(5F;kV5Xvrj2dU~@e5FqFkF|S$FSY~?rY4=wfe_nS>@w9gnHMV;; zX(N`evA;Vb>)hKfWSO&;{jY>|^+zSrB<4oULCJmF>h+;luO}}lK~iPGkDjqq({^!= z_dv1pNSE77k0x1gWo8-GqnxbxK)tgp7+q+T1Uf?3zcezXAARr-*z7t>Gk0m8F;dc= znW-X`mXCfD5f$Abh%Tfl@wpo(gA?SK`;}JI;N5=N28LRLHqRq5y;TSgIMhxeRI@#M z^vMI}r}ifg@a~YGjNiB$NT@v5*2bgPlqb(X5+CE^Gxg2P9t@9M3s%71_1m&F`rdD~ zjsPF(Z5A2`jw1bi?#|NHXMEJdJF+cF$=?=w>kF*hloL#G5dx7Dh7#L+?$)2zTJO%F zCK+gGn);iZFzP`=(=`8w4=fxsH2jlm+IGAd6=r7EexO135oB0sLEjcD7Js|OB)kl4 zbQg`IJc<2|QyM8kBKQKc_!CJ~=oq}C^k&1|uJJ7&zlr{Volxk*Q$|C+l<4DLB;E*d zz4hEl+(0ymaDT0>m-A(P0-2Dz?{_m+^rj@0Dn_fp*nsCrpL14U*XMiAx2T8+f6)7a z29h@EpbL%qYJW@=G;%;b07UAj?AMC~p*@2EpfbJ#X89TOI+9syxA7Vi`hZl#!e>HoK`OG;7HBdF=!p9v+Vi2)Rrr-*~KNJ#)pyFdDT+%}PqFEO_l63r31^*tDD7 zPmjW;rlx}P@~Co5wKe?qWG*2fFp2RH%yNt8Luj1n3Pu0~w zCFihW27Y+$8i6b8>)Tf1b#;rgP_BJreZDR{$YY5q@P#Sq2iS$I^mHfhq42 zU;s}IE#1qTjrzy0EXOP?OCzjN0bU@S>ER{XuVH>iueBWi+vaBhlGe20@*s{BR>Tba zt#@vpI;neJtevZlCKqOwC)J(SG$dzMh6z8cO}JHm*y|2=+WB;;uxcFfyj(B4WoA|y zj(|#N51R{b7+sHg=gx)8%3*O(@ytb+;Egosw8O;2G_GBtk)?NrLqf_y_XO$%4rZ<;Xz~)XfoX7vQ;6O7v2#z1 zY~$%FdYNvL`HU)Qa@J)Ux_a@+?t80$tQ6Uy$xB=(B+Mc}mTEjb{*^U%byn<5l-Io^ zmza-WR!8zDm+K}D;??SJlm9NB|M=7wV2bvo`zbh;M2>3zjiCVgLXD literal 0 HcmV?d00001 diff --git a/doc/_themes/sphinx13/theme.conf b/doc/_themes/sphinx13/theme.conf new file mode 100644 index 000000000..876b19803 --- /dev/null +++ b/doc/_themes/sphinx13/theme.conf @@ -0,0 +1,4 @@ +[theme] +inherit = basic +stylesheet = sphinx13.css +pygments_style = trac diff --git a/doc/conf.py b/doc/conf.py index 1b8ba3e4d..f978f3154 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -18,7 +18,8 @@ version = sphinx.__released__ release = version show_authors = True -html_theme = 'sphinxdoc' +html_theme = 'sphinx13' +html_theme_path = ['_themes'] modindex_common_prefix = ['sphinx.'] html_static_path = ['_static'] html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']} diff --git a/doc/develop.rst b/doc/develop.rst new file mode 100644 index 000000000..4181cde86 --- /dev/null +++ b/doc/develop.rst @@ -0,0 +1,103 @@ +:orphan: + +Sphinx development +================== + +Sphinx is a maintained by a group of volunteers. We value every contribution! + +* The code can be found in a Mercurial repository, at + http://bitbucket.org/birkenfeld/sphinx/. +* Issues and feature requests should be raised in the `tracker + `_. +* The mailing list for development is at `Google Groups + `_. + +For more about our development process and methods, see the :doc:`devguide`. + +Extensions +========== + +The `sphinx-contrib `_ +repository contains many contributed extensions. Some of them have their own +releases on PyPI, others you can install from a checkout. + +This is the current list of contributed extensions in that repository: + +- aafig: render embeded ASCII art as nice images using aafigure_. +- actdiag: embed activity diagrams by using actdiag_ +- adadomain: an extension for Ada support (Sphinx 1.0 needed) +- ansi: parse ANSI color sequences inside documents +- autorun: Execute code in a runblock directive. +- blockdiag: embed block diagrams by using blockdiag_ +- cheeseshop: easily link to PyPI packages +- clearquest: create tables from ClearQuest_ queries. +- coffeedomain: a domain for (auto)documenting CoffeeScript source code. +- context: a builder for ConTeXt. +- doxylink: Link to external Doxygen-generated HTML documentation +- email: obfuscate email addresses +- erlangdomain: an extension for Erlang support (Sphinx 1.0 needed) +- exceltable: embed Excel spreadsheets into documents using exceltable_ +- feed: an extension for creating syndication feeds and time-based overviews + from your site content +- gnuplot: produces images using gnuplot_ language. +- googleanalytics: track html visitors statistics +- googlechart: embed charts by using `Google Chart`_ +- googlemaps: embed maps by using `Google Maps`_ +- httpdomain: a domain for documenting RESTful HTTP APIs. +- hyphenator: client-side hyphenation of HTML using hyphenator_ +- lilypond: an extension inserting music scripts from Lilypond_ in PNG format. +- mscgen: embed mscgen-formatted MSC (Message Sequence Chart)s. +- nicoviceo: embed videos from nicovideo +- nwdiag: embed network diagrams by using nwdiag_ +- omegat: support tools to collaborate with OmegaT_ (Sphinx 1.1 needed) +- osaka: convert standard Japanese doc to Osaka dialect (it is joke extension) +- paverutils: an alternate integration of Sphinx with Paver_. +- phpdomain: an extension for PHP support +- plantuml: embed UML diagram by using PlantUML_ +- rawfiles: copy raw files, like a CNAME. +- requirements: declare requirements wherever you need (e.g. in test + docstrings), mark statuses and collect them in a single list +- rubydomain: an extension for Ruby support (Sphinx 1.0 needed) +- sadisplay: display SqlAlchemy model sadisplay_ +- sdedit: an extension inserting sequence diagram by using Quick Sequence. + Diagram Editor (sdedit_) +- seqdiag: embed sequence diagrams by using seqdiag_ +- slide: embed presentation slides on slideshare_ and other sites. +- swf: embed flash files +- sword: an extension inserting Bible verses from Sword_. +- tikz: draw pictures with the `TikZ/PGF LaTeX package`_. +- traclinks: create TracLinks_ to a Trac_ instance from within Sphinx +- whooshindex: whoosh indexer extension +- youtube: embed videos from YouTube_ +- zopeext: provide an ``autointerface`` directive for using `Zope interfaces`_. + + +See the :ref:`extension tutorial ` on getting started with writing your +own extensions. + + +.. _aafigure: https://launchpad.net/aafigure +.. _gnuplot: http://www.gnuplot.info/ +.. _paver: http://www.blueskyonmars.com/projects/paver/ +.. _Sword: http://www.crosswire.org/sword/ +.. _Lilypond: http://lilypond.org/web/ +.. _sdedit: http://sdedit.sourceforge.net/ +.. _Trac: http://trac.edgewall.org +.. _TracLinks: http://trac.edgewall.org/wiki/TracLinks +.. _OmegaT: http://www.omegat.org/ +.. _PlantUML: http://plantuml.sourceforge.net/ +.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/ +.. _sadisplay: http://bitbucket.org/estin/sadisplay/wiki/Home +.. _blockdiag: http://blockdiag.com/ +.. _seqdiag: http://blockdiag.com/ +.. _actdiag: http://blockdiag.com/ +.. _nwdiag: http://blockdiag.com/ +.. _Google Chart: http://code.google.com/intl/ja/apis/chart/ +.. _Google Maps: http://maps.google.com/ +.. _hyphenator: http://code.google.com/p/hyphenator/ +.. _exceltable: http://packages.python.org/sphinxcontrib-exceltable/ +.. _YouTube: http://www.youtube.com/ +.. _ClearQuest: http://www-01.ibm.com/software/awdtools/clearquest/ +.. _Zope interfaces: http://docs.zope.org/zope.interface/README.html +.. _slideshare: http://www.slideshare.net/ +.. _TikZ/PGF LaTeX package: http://sourceforge.net/projects/pgf/ diff --git a/doc/install.rst b/doc/install.rst new file mode 100644 index 000000000..b39f71674 --- /dev/null +++ b/doc/install.rst @@ -0,0 +1,15 @@ +:orphan: + +Installing Sphinx +================= + +Sphinx is available as a package on the `Python Package Index +`_. + +You can also download a snapshot from the Mercurial development repository: + +* as a `.tar.bz2 `_ + file or +* as a `.zip `_ file + +.. note:: A detailed installation and setup guide is in preparation.