From ff175387b33c92ed344b433b90bbac7a0c3fe6fd Mon Sep 17 00:00:00 2001 From: Andrea Gavana Date: Sat, 7 Apr 2012 21:00:39 +0000 Subject: [PATCH] Phoenix: Add support for documenting wx.lib, wx.py and wx.tools (that's the whole wxPython/Phoenix documentation) git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71139 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- build.py | 45 +- docs/sphinx/_downloads/i18nwxapp/app_base.py | 15 +- docs/sphinx/_downloads/i18nwxapp/app_const.py | 16 + .../i18nwxapp/{i18ntools => }/geni18n.py | 28 +- .../i18nwxapp/i18ntools/i18nwxapp.pot | 73 -- .../sphinx/_downloads/i18nwxapp/i18nwxapp.zip | Bin 8916 -> 9062 bytes .../_downloads/i18nwxapp/locale/I18Nwxapp.pot | 73 ++ .../images/overviews/htmlcell_descent.png | Bin 0 -> 1984 bytes .../images/overviews/htmlcontcell_alignv.png | Bin 0 -> 1425 bytes .../images/overviews/htmlcontcell_indent.png | Bin 0 -> 6488 bytes .../images/overviews/htmlwin_border.png | Bin 0 -> 3256 bytes .../images/overviews/overview_html_cont.png | Bin 0 -> 7557 bytes .../overviews/overview_html_contbox.png | Bin 0 -> 3592 bytes .../images/overviews/overview_html_hello.png | Bin 0 -> 1699 bytes docs/sphinx/_templates/main.html | 4 + .../overviews/html_overview.rst | 646 ++++++++++++++++++ .../rest_substitutions/overviews/index.rst | 3 + .../overviews/internationalization.rst | 60 +- .../python/converted/ContextHelp.1.py | 2 + .../HelpControllerBase.SetViewer.1.py | 4 + etgtools/sphinx_generator.py | 4 +- sphinxtools/constants.py | 32 + sphinxtools/librarydescription.py | 229 ++++++- sphinxtools/modulehunter.py | 10 +- 24 files changed, 1105 insertions(+), 139 deletions(-) create mode 100644 docs/sphinx/_downloads/i18nwxapp/app_const.py rename docs/sphinx/_downloads/i18nwxapp/{i18ntools => }/geni18n.py (73%) delete mode 100644 docs/sphinx/_downloads/i18nwxapp/i18ntools/i18nwxapp.pot create mode 100644 docs/sphinx/_downloads/i18nwxapp/locale/I18Nwxapp.pot create mode 100644 docs/sphinx/_static/images/overviews/htmlcell_descent.png create mode 100644 docs/sphinx/_static/images/overviews/htmlcontcell_alignv.png create mode 100644 docs/sphinx/_static/images/overviews/htmlcontcell_indent.png create mode 100644 docs/sphinx/_static/images/overviews/htmlwin_border.png create mode 100644 docs/sphinx/_static/images/overviews/overview_html_cont.png create mode 100644 docs/sphinx/_static/images/overviews/overview_html_contbox.png create mode 100644 docs/sphinx/_static/images/overviews/overview_html_hello.png create mode 100644 docs/sphinx/rest_substitutions/overviews/html_overview.rst create mode 100644 docs/sphinx/rest_substitutions/snippets/python/converted/ContextHelp.1.py create mode 100644 docs/sphinx/rest_substitutions/snippets/python/converted/HelpControllerBase.SetViewer.1.py diff --git a/build.py b/build.py index 5e8ccd46..baa96d52 100755 --- a/build.py +++ b/build.py @@ -68,8 +68,9 @@ Usage: ./build.py [command(s)] [options] SIP files sphinx Run the documentation building process using Sphinx (this needs to be done after dox and etg) - wxlib Run the documentation building process using Sphinx for - wx.lib (and possibly other pure-Python modules/packages) + wxlib Run the documentation building process using Sphinx for wx.lib + wxpy Run the documentation building process using Sphinx for wx.py + wxtools Run the documentation building process using Sphinx for wx.tools sip Run sip test Run the unit test suite test_* Run just one test module @@ -125,7 +126,7 @@ def main(args): elif cmd in ['dox', 'doxhtml', 'etg', 'sip', 'touch', 'test', 'build_wx', 'build_py', 'setup_py', 'waf_py', 'build', 'bdist', 'clean', 'clean_wx', 'clean_py', 'cleanall', 'clean_sphinx', - 'sphinx', 'wxlib']: + 'sphinx', 'wxlib', 'wxpy', 'wxtools']: function = globals()[cmd] function(options, args) else: @@ -598,7 +599,7 @@ def sphinx(options, args): def wxlib(options, args): from sphinxtools.modulehunter import ModuleHunter - cmdTimer = CommandTimer('wxlib') + cmdTimer = CommandTimer('wx.lib') pwd = pushDir(phoenixDir()) libDir = os.path.join(phoenixDir(), 'wx', 'lib') @@ -612,6 +613,42 @@ def wxlib(options, args): ModuleHunter(init_name, import_name, version) + +def wxpy(options, args): + from sphinxtools.modulehunter import ModuleHunter + + cmdTimer = CommandTimer('wx.py') + pwd = pushDir(phoenixDir()) + + libDir = os.path.join(phoenixDir(), 'wx', 'py') + + if not os.path.isdir(libDir): + raise Exception('Missing wx.py folder in the distribution') + + init_name = os.path.join(libDir, '__init__.py') + import_name = 'py' + version = version3 + + ModuleHunter(init_name, import_name, version) + + +def wxtools(options, args): + from sphinxtools.modulehunter import ModuleHunter + + cmdTimer = CommandTimer('wx.tools') + pwd = pushDir(phoenixDir()) + + libDir = os.path.join(phoenixDir(), 'wx', 'tools') + + if not os.path.isdir(libDir): + raise Exception('Missing wx.tools folder in the distribution') + + init_name = os.path.join(libDir, '__init__.py') + import_name = 'tools' + version = version3 + + ModuleHunter(init_name, import_name, version) + def sip(options, args): cmdTimer = CommandTimer('sip') diff --git a/docs/sphinx/_downloads/i18nwxapp/app_base.py b/docs/sphinx/_downloads/i18nwxapp/app_base.py index d68fb740..567b8284 100644 --- a/docs/sphinx/_downloads/i18nwxapp/app_base.py +++ b/docs/sphinx/_downloads/i18nwxapp/app_base.py @@ -26,6 +26,8 @@ def _displayHook(obj): import __builtin__ __builtin__.__dict__['_'] = wx.GetTranslation +import app_const as appC + from wx.lib.mixins.inspection import InspectionMixin class BaseApp(wx.App, InspectionMixin): @@ -35,13 +37,6 @@ class BaseApp(wx.App, InspectionMixin): sys.displayhook = _displayHook self.appName = "I18N sample application" - # define the translation domain, the name has to match your .mo files - self.langDomain = "I18Nwxapp" - # languages you want to support - self.supLang = {u"en": wx.LANGUAGE_ENGLISH, - u"fr": wx.LANGUAGE_FRENCH, - u"de": wx.LANGUAGE_GERMAN, - } self.doConfig() @@ -89,8 +84,8 @@ class BaseApp(wx.App, InspectionMixin): """ # if an unsupported language is requested default to English - if lang in self.supLang: - selLang = self.supLang[lang] + if lang in appC.supLang: + selLang = appC.supLang[lang] else: selLang = wx.LANGUAGE_ENGLISH @@ -101,7 +96,7 @@ class BaseApp(wx.App, InspectionMixin): # create a locale object for this language self.locale = wx.Locale(selLang) if self.locale.IsOk(): - self.locale.AddCatalog(self.langDomain) + self.locale.AddCatalog(appC.langDomain) else: self.locale = None diff --git a/docs/sphinx/_downloads/i18nwxapp/app_const.py b/docs/sphinx/_downloads/i18nwxapp/app_const.py new file mode 100644 index 00000000..95095afc --- /dev/null +++ b/docs/sphinx/_downloads/i18nwxapp/app_const.py @@ -0,0 +1,16 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*-# +# +# Author: Werner F. Bruhin +# Purpose: Application constants +# Created: 06/04/2012 + +import wx + +# language domain +langDomain = "I18Nwxapp" +# languages you want to support +supLang = {u"en": wx.LANGUAGE_ENGLISH, + u"fr": wx.LANGUAGE_FRENCH, + u"de": wx.LANGUAGE_GERMAN, + } diff --git a/docs/sphinx/_downloads/i18nwxapp/i18ntools/geni18n.py b/docs/sphinx/_downloads/i18nwxapp/geni18n.py similarity index 73% rename from docs/sphinx/_downloads/i18nwxapp/i18ntools/geni18n.py rename to docs/sphinx/_downloads/i18nwxapp/geni18n.py index 650184d3..449d5668 100644 --- a/docs/sphinx/_downloads/i18nwxapp/i18ntools/geni18n.py +++ b/docs/sphinx/_downloads/i18nwxapp/geni18n.py @@ -1,13 +1,14 @@ # -*- coding: utf-8 -*-# #!/usr/bin/env python """ -This will generate the .pot and .mo files for the application domain and languages defined below. +This will generate the .pot and .mo files for the application domain and +languages defined below. The .po and .mo files are placed as per convention in "appfolder/locale/lang/LC_MESSAGES" -The .pot file is placed in the current folder. +The .pot file is placed in the locale folder. This script or something similar should be added to your build process. @@ -18,16 +19,19 @@ catalog. """ -domainName = 'i18nwxapp' -# define the languages you are supporting and need translation, so if texts -# in your source are English then you don't need 'en' here -supLang = ['fr', 'de'] +import app_const as appC + +# we remove English as source code strings are in English +supportedLang = [] +for l in appC.supLang: + if l != u"en": + supportedLang.append(l) import os import sys import subprocess -appFolder, loc = os.path.split(os.getcwd()) +appFolder = os.getcwd() # setup some stuff to get at Python I18N tools/utilities @@ -37,12 +41,12 @@ pyToolsFolder = os.path.join(pyFolder, 'Tools') pyI18nFolder = os.path.join(pyToolsFolder, 'i18n') pyGettext = os.path.join(pyI18nFolder, 'pygettext.py') pyMsgfmt = os.path.join(pyI18nFolder, 'msgfmt.py') -outFolder = os.getcwd() +outFolder = os.path.join(appFolder, 'locale') # build command for pygettext gtOptions = '-a -d %s -o %s.pot -p %s %s' -tCmd = pyExe + ' ' + pyGettext + ' ' + (gtOptions % (domainName, - domainName, +tCmd = pyExe + ' ' + pyGettext + ' ' + (gtOptions % (appC.langDomain, + appC.langDomain, outFolder, appFolder)) print "Generating the .pot file" @@ -50,10 +54,10 @@ print "cmd: %s" % tCmd rCode = subprocess.call(tCmd) print "return code: %s\n\n" % rCode -for tLang in supLang: +for tLang in supportedLang: # build command for msgfmt langDir = os.path.join(appFolder, ('locale\%s\LC_MESSAGES' % tLang)) - poFile = os.path.join(langDir, domainName + '.po') + poFile = os.path.join(langDir, appC.langDomain + '.po') tCmd = pyExe + ' ' + pyMsgfmt + ' ' + poFile print "Generating the .mo file" diff --git a/docs/sphinx/_downloads/i18nwxapp/i18ntools/i18nwxapp.pot b/docs/sphinx/_downloads/i18nwxapp/i18ntools/i18nwxapp.pot deleted file mode 100644 index 14cb9a8c..00000000 --- a/docs/sphinx/_downloads/i18nwxapp/i18ntools/i18nwxapp.pot +++ /dev/null @@ -1,73 +0,0 @@ -# SOME DESCRIPTIVE TITLE. -# Copyright (C) YEAR ORGANIZATION -# FIRST AUTHOR , YEAR. -# -msgid "" -msgstr "" -"Project-Id-Version: PACKAGE VERSION\n" -"POT-Creation-Date: 2012-04-05 12:12+Paris, Madrid (heure d’été)\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=CHARSET\n" -"Content-Transfer-Encoding: ENCODING\n" -"Generated-By: pygettext.py 1.5\n" - - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:17 -msgid "The I18N sample application" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:28 -msgid "Close" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:29 -msgid "Close the application" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:31 -msgid "&File" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:36 -msgid "Edit something" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:37 -msgid "Edit an entry of something" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:40 -msgid "&Edit" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:45 -msgid "&About" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:46 -msgid "About the program" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:48 -msgid "&Help" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:58 -msgid "A nice label for the TextCtrl" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:62 -msgid "a search control" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:68 -msgid "Open a file dialog" -msgstr "" - -#: h:\devProjectsT\PhoenixI18N\i18nwxapp\sampleapp.py:80 -msgid "Choose a file" -msgstr "" - diff --git a/docs/sphinx/_downloads/i18nwxapp/i18nwxapp.zip b/docs/sphinx/_downloads/i18nwxapp/i18nwxapp.zip index 3522adc7d00d0808c05914961b59e8bcb278cc4f..b3f210d67f2c8fea8f19b78b41c8da23762b6359 100644 GIT binary patch delta 3704 zcmZvf2T;>X*TzE#9RwltBA`f30)$>fS}2h!ps0Y9AU*UV>ZG)w8<;2pfsr+bFT)1Obu?_L+YJCUL}N}m2e2P9na)TZbVp9DbuOcT`R zF}0Zv^I1Z;ElrvG&^VY_AJ!8ZcQA+Bwuc)aSv3N}hT zPqIV7-)^Y`YFmM@PLe!ibdQcZx15V?C{|6@BCP<7+vV`>I8-HinZw03#p{kK+CrRKDmP2kQ)Keb`$WSI=t4x-ycXsDs7~yM3{9k@8Iq!Zgz_g4IZp@kMFNv zT!fLL=I#qVnB-C_bTyPF21Gxc)+URG%8Fsec)zyLd}wzwF6?40iKXFA8NRxqYLN7z z4h%PKqPdv{xmSP33gJp@c0NUxWRdOwb?N{JDv|^|EClPU;MQbETnTFW7zH_|{#CS4 z5Ew-Nt57d`kK8i8MFRq%SwJABllnXAM+}N4zeumb~g)m`xb?}{PH^poFX&vhP#=N#0cdKx^ zx8eQZmgp6&*%`2hoCUp3Ou3X8@*^grOW^&a^*g6ic+P!x&-m_bxCgcB0L#|rUHrFm z^72e#KT{kE*)Ky52CrVK2ORB4IhTsl7S5_x<96q4d??d|@lL1SgmN6War7M-73`NZ z^cBfksg#^rMPwHv-;a)W&AJ=CW)|C4IZ5Ws$oO+#1*+cSx~Y)chjr%BRR=_Nrlk4S2xpWbbJD5M;zwUeCW?#&BoK&3KMa>p~j4Jz&l;kK7Pgv>2|on~Br2CU4-%@{ZAiWM7y8Uw zv{f$L*u0LD^pjLITJ)D}Krc0Q$as)_?Xf-=Y$xTJG5wummgZQ`rdqVt ziYF{`-kdWgYh*vK=OI;I3$*@x@h90}+73Qrqy)}xv4jE`W@`Jbri8;rGtuOvh(?ZK zn4JNu|C_4pv*~+I7HV?Ugybf%DRokAE>kg+stGNfQATg9Q=ne9uqcso zf&QKNQRcDy&CmJWI&gec|J0d4S>4Rbs?+qEETdcx8h9JvOWe>f_S-9qGs3Q)`Pz$E zZ8~FE2yMU@LvNX-o@eh@ra91K?w+HnIT{lOR)%qUA5!fS+9j5uF!g6@ejAz%nvMaD zlYV^ScFvvx{#j5?RAj|u6PCH%xQydLY zX^Ob3qx3lI?P-ln*Hq6kmSG?Z_llt@y}^}`G0>dqEt*s#R1lcC0X;hYV@x>GoS4~LXxA5h z(3ys+EeK`|4-dr&^ppPhFix48*P;?M!+P9YYP+y!)W>H3^5zz2P!eZX-j{DvI~R<* z1UTipAQdU^{T1MiY>kt>x|LWr)GN7LXD4>9T3?NPbznO;i6T?^>9Y?Z>}EILA(v$Zj8WWbbSTWz#-$Dk zxicB-Ze)>$w3425zU$07OzRpaz4t1}ib2|KZ#zp8@Vya*E5h{qf7a>7KhpDZLIH;| zST+Pvtv@G1`$*%fCflb*Z_;(6$cm@QZ^E92W+yet4D@8wsC-5twhOQozNE69$;bk+nBju;qE}4% z>~;e$W^-Q_j;;O_i1M|oSUY0B~!DA>VNcNxtftddf&CXb#fWQ+rV^Yk})N*Xy z8_^L7a^ZNNI+!Si*m{#((6gmQ zI+1r&zvtWVVA32GYlic!A{mHSimm^P?2;PB({*C)*RG1m$n^MPJ537^k7E=klh~!4 zzxj8zj!M}`F23A`pAL{FaN99-!(cvN>$5M(br=fa8inGWugOmYjM2?7ecg$Ey6mC> zQhZ;gD8q5$!q2FXlFD-T zM~T{ zk9J+dubWKC;lT~^mX;PbJQ-qj@MsZ3w-*1?<@q=1aN+Dsclk210$(&41uO}ZvqFpF zicN%qjey}=N+Xf2r@(~+Kg!mspv|p$Y8?11h1-o8Jun3G#zIx%&dER5eqKFFm~Ko) zvpLT*6&fVhB(yWAZhT6Bh(}tP%!AG3sa1s=)}By;vt>AJX_eksj^||VXcRt`jY$aW zj?PH-VwsC!OkdH!usPE%XVK}G6K&6YI7WQ30usIWHE%Ha(b7Tg$Fv$uJhFdYv-tL6 zhazbqk*!F4eO@gLS)^x}YE&C(VDypkLL`@l>m#{7JB~ZmaGD{5pg_tpqh(x~l);bh z@g-%l3Tu|tWy#(ukxZ{&SGy~}l7z&y^mFKNPMGiUK^V|CA}GE_8H=>8_;6<99#32%vGwfEnS?g} zV@VHEA-mJ%h_)9-{)`gnSESnyH9c2lH_5==TaHpXJ6mQ~T)#1Lc`~eU4NzCYjs}r! z!9OB|xJ2z)VbRG9)sEUg^~c(kk>2g}ErG1Cnb3XUEu!I`d)x8Y;!nq%z{3sejD5}z zs9f$RuOzEEW;Rs-cN_7G$ohvR_WIXqqBqsJnejW-h77Tf zXYj8iH49KYMlJw#Wti~ClxCb++kpJDhpx9&PYnu|797dS5a>*G*O2LT*zc|TvA0V8 z3|;0Or0cDdsMX3Y_2Vpy$rGW=zzyEJaC~4L(06(I`!Z(j77?-hQyCvCDs|@M-+=-g zy?wnffAun9=4dJ~^sn#uS0995JHroVrol4`Bf)Yscr9Tiuq_QfL|6x$LW6G>HU$sU zmo{EZD#xc3lILeh!i;J*Y+HKR+t%2Cn^Mf#(HuT#luACf#2Ts-@VnZ z$54TUPu4Z||J`Z*{k-21{_TE$M@Z!ShZp`WjQZO*{~OM~l|1}^EB_zWzomaG|IMx6 aN=1SHrkFXJhW6Lpsgs#;!nu~elKmfB?1z*9 delta 3501 zcmZ`+2UOF^)(?SzkN^=v5Cj59?`1`r^w4`1kuE(DdWXLvps*k%G(}jXNQ{LDp(@e@ z1BNO{Q<@Um0wSP-fG>XEp7-{hvv20i+_`gR?zwYj?%dyxYB-K&ur{M-z$psy0s)Gu zA(2=tCPMz#6aoYWodO}f(sX>P)Z4GpgFru-Kp+GN1p3c9KcA3aid<-1jl=BiSrvHF zij#TcCGza|u@|z)RsCmCNJu`ZlPY@_LHaF!+FGQ`4D&O|&)69mjYAj*cM|b;B7BGV z@|}o>aS$LoxNvP-us0;?jkMF!daVUZa)X`k4Jx$7?!C)70)YedRjN}rfb}Bpo|5pZ zi`_HRr^ZM`0hvfs?`uPcN2cnv4(F=s882%X`-E2%J+P{;?L=z$5YzYr6D~n3$+5!= z)kdM0RS**Ns(bd$2PtA7rOp|k4az2D53`%H$6El;%)!|o9rM8`6p%2b<;WRLsnB_n zm1~cfoDtb(=3udWn&zeVvG8}DV+IY6_qfaO@d{FPVY|iMAg1Xi288TA%on0rW>Hx) zYr2ApXlY4x`f3ex+o^EkiE^>$V^sA!aa*!rbtfXf^D*NSExVQISt&W)tXF0gMgzo~ zov8ptgVi7fr$rD8yY5$Z-B7S`^ZsshiLY2ao2I1M;|Axk-D~AzFaatTQ@+#}3@As+ z;OQ~<?-$uroCOp&SWcdrNqbKlIj_h_`0Tu(MnsB*I_8`y>V|0+vXD0(7KGyJA7If z?zP^gq{Qo$+VSNiMcZxu<*+h)DT2#WLWDPFM!;E@;FWEJu`STZCS4)Bf2Mvf%>g+6b9Z29tiIl-?tJu_Dfz@L^T^5^pl!+J%Ytb)A#DRBZPqcpBK>-J@;-7W z*Mf4EC(y&o^Z#Ek7!)s}x0 zp`%QSsdh%Q5CgmCXH{GxXZVBEukEL}TjI-)wpr&@$o*E-eg&N&F5!7(oW@wPKn&G& zYc*(BwvSwQaP-}^{qqJULT)`ArFnYoPZfM?{Db>_Jml#MiAb#;p2gw@K=&D!F|MsT zsYj)%qc#mz&dD-8Stx*g9w@MT1(Up=)aBPd&voqnpWsaOOw$>B+YEICgFt9naB}}w zaQ=$Sm{`xyP`OZSWMjd+<*WkY=5}7}%_?Cbcy$my!Yop5h-N8-HN*NhxN7EKr@-}HUuoH8cZGtTENKx`;Olf;F5 zpVk!4ABbcxgdW^7Z(Fl+iup)Ad?nQewyISQ5qj^zuC^t6*IbVeJwH@x6*#uoMHslm z((cwkD8Ll8w<0?HD`Dd21@Mo7k_99s@0i{~QFB3IEFXeR(Zx*VbJU#cOO*)h3iV*i z?y6Bdb6t%@S)9IS>{xcg$o8RwxSFdO%i14K`|*ctih73>LXpj+U+i^7T?MGjuv!8v z@dfMiYFk4Y<~o+jRMNuMTvV4)e1jJ0pnPTe?$z;IlFrTx!a%%xbJ$0qtr@Zbz0(f4 z__`;!*%u%t1w)@oOb%E)gxc+)lcb>C-?@#$g{28EXOt0!sweO|=_|GY9_6QFWzFLNx%efFTA#DK=DH|X9`_$6ZS!O}223`5o&adpp?yfyMLq6PKvv=q%zaFN~x71>vZmx+ZkZO>d; zV^qLgqDuWjqs2uCSLT`Ml>Bf(;y8e;&O%gHJ>zTk4p^yt$={Tpv)6%Bgzz?qK}K1D z9a^#=$+6z;gn&TlY#HB& z+Yp5+>nwG`3M#jbzolc)j@vB)tSnd4<%j9>rs+V5x{pS?9ay$85?8ObLz{kMTWeE* zer60w1~eGPy&l6;8EuM8eY@XCWT=IZq-%Ql`lLTY9AUpNyN)x4-#feX=8^QK$l7ei&=&f#TWyY<`Pk^f$!#(MG%WtO1$?2|A+I=AswSk+n4*K1eg zYN92N3ro=1fu}E&;&RNp6M51oT^fs@U&wHRD{_)cLpOP&XT_7MYOMGOCUuKvk}W@4 z(C!#X602fRh-U2OH5Dy6^L$8SC9nPuuL+(gUc7X%3T_`G9_Z3mBv4?XuV^H^{i-{{ z%PqVn}fwDOcwd=>6>Ua%$w*Ae6&xgAQ`^&50u}KNL zpYM101a|28dAXQ7eJk$yy*Mr$vvb9L4$wrs?A+b%%KZdTyH_*riM8Jl8Mvw!Hqt_E zig~Q_!en^&NY7ea`K?Q4vcz_({FV#^dnZzw8d8_WGjLCRGv#w(}@I*d#}u}_HO2>Pq%MwBOI``B{c$_ zy$c!3E#m8aj#R60-8s9G@~!L=JGAyhmW7sVF@3BQg>TaQY^5yEd9SU`putedvKZM9 zcTZNhPY?U4P0t7iEsc@f{XmUn3U@;53o%gFqzw8#pvQ38VV#OJoEzElksAsd@h6jmd^+ss%%&Y@P+lKIZ zlYTf@aYHtkQDwCSv|zx%HT&WGOzX&Vm@JRG|CYB>&xEtSamS3ts>HnH;c-ueVVi9i zmkChkOi4J@*N&z-dSX#pMz`ZZ#W-hTyJIjdY%N{r?Yos@J%{qYbR(n&&bkIP||F(2OP2qa9>0(^dByrE$ zMt|jrbKc+(92Cg;0D{&XvVP(Zf!)4n@a7TM)2WSjx{{A88Yf&H91VpXXx%EBNC>#- zVDd`Lch9aut%=>>M{1JpvF7SU_@|~|@>!Flhqajlaka4}8QkMkRn$?zxBXl!N0LwA z5Z1-io{e2;Ynp{^f^luUq)pZ!Q{Ayc#&*Ub;FT|_&cV!maO8&e@IsEOoN1#NRcobu zJi~DDv0bI5vm4~#TW8<%n?*MU)pN&vzp+gh%(YlGR9~2S>uR5H-}rKn%l1#cNy?;K(QeF-~3(D8e&16yx)MXf4j#3_^1i1Y)DrKWJw} Ip?+!q0{AOC>Hq)$ diff --git a/docs/sphinx/_downloads/i18nwxapp/locale/I18Nwxapp.pot b/docs/sphinx/_downloads/i18nwxapp/locale/I18Nwxapp.pot new file mode 100644 index 00000000..3f37ba07 --- /dev/null +++ b/docs/sphinx/_downloads/i18nwxapp/locale/I18Nwxapp.pot @@ -0,0 +1,73 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR ORGANIZATION +# FIRST AUTHOR , YEAR. +# +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"POT-Creation-Date: 2012-04-07 10:49+Paris, Madrid (heure d’été)\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=CHARSET\n" +"Content-Transfer-Encoding: ENCODING\n" +"Generated-By: pygettext.py 1.5\n" + + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:17 +msgid "The I18N sample application" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:28 +msgid "Close" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:29 +msgid "Close the application" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:31 +msgid "&File" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:36 +msgid "Edit something" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:37 +msgid "Edit an entry of something" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:40 +msgid "&Edit" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:45 +msgid "&About" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:46 +msgid "About the program" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:48 +msgid "&Help" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:58 +msgid "A nice label for the TextCtrl" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:63 +msgid "a search control" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:70 +msgid "Open a file dialog" +msgstr "" + +#: h:\devProjectsT\Phoenix\docs\sphinx\_downloads\i18nwxapp\sampleapp.py:82 +msgid "Choose a file" +msgstr "" + diff --git a/docs/sphinx/_static/images/overviews/htmlcell_descent.png b/docs/sphinx/_static/images/overviews/htmlcell_descent.png new file mode 100644 index 0000000000000000000000000000000000000000..af6278c2c21e429471ab576fc5977577c906a9f8 GIT binary patch literal 1984 zcmV;x2S50UP)Px#Fi=cXMFRr`jg5=V%*~%HKK@p4{{H;@lcN0-H~i4oN=ZpQIXwKZytcHp{6b%F zaB}{4igsA8VgLXKK1oDDRCwC$nn7sWRv5>fK_N9IltK?1I}Cv!>%3DBqj$UM#jF+n zY&DYW%iI)7PL1<2j0p>QNk^KlrHtZGN;(*3w^#)50RzYsU}X~z6n!`V%O!yP41ks; z!vR=*0g#yiC8dzzc>n=wLjahXU9BvYc1v^K1y{U;(l$59>O7x3LNGrlRXQ9a19t7-vKIIx#LXj5I_zCkN{P*zeKiPRZ$lA?q8)H0mzqW2mzjeDj1+H7?QaFs%kEXs;C+X z6OTnz>p@KQi>`p%vhTE|=%4+Bu3 zdnJo!MfAqesoR5+V2Hf~ur#ng1YQ-<fO2Y(KcgnC;S*ujSjlS}R-5E>x20y0SjtqrX^zxSMz1-l;sS00!v zRCWRs0C>8$AQ_?U8xx@cDw)~f<#}^?9RDX&CBRL^kj<2XJb?X=ne}?zo${n!6j%@( z?d!|a&t?sF^wn!a@MvGgVtCCk67EZe{h@@=aT8;oRvqmwO9W@w(b}~$RgczO54ze~ zwffFJy5sp-SG(N;uy%)h|IO*|t>bH6AHfOW_v%CbwdTL?p6&u*p;bdccx0>i`Vn8V z1iJ4;fUeK}?sy2sTTIA)h~EfE#TPvm#Ll*QuE!{-IO>5k_0B>k1HN?eWsd-_bHTGA zn~RPF0raW>TNwq^1NO?~#9;x*Q^oiGRq>@*ORL^9`{@D5kYe870~cfM?Sa@o4?y9n zmPz?4;0B02=;IJ%p;&v-EkJ8c5)L4PQBdr_gstr;&jTw~eT`MNu7R@2mR!0f%j}%$ zn;`2N--HunKA`7JTu{O4!|g92o$2_=TTCCQnmy+_UI$N*2+-OGGq=iu!GlDcr_vQ&xDg4fH4k0 zmS_s0*on4-C58gabIfA3vLb7l8bJVdO?ClnCzAo0Q04%{IUYa-fD|)CP9X~p$wY}= zsg?8Sv;x`5fTfO)3H{6Rw#FX|E28u5saNHgaMcRK_vs>bqAitisgXn{rj(cL z&ZkmrzWWvpXKluKt_{=Pn^d&@KXFbJ*r}L3Y`H00=}lpeyzQl8ObK|r+1p-m+_ir` z(zkjb5I}MZev6ZeU-ki@;k{Sv8kCcLn~sA$;QEQ=0%yB?@$iPg+M_zwHai}H!Fj;m zoqgMqm*XM~&I8Ros=bW?=`%d}1z><4Xx8QN`}O+g&)2v=838O^IlLjTCj&Px#Fi=cXMK3iwl9H5CR93du?Di5A_F`oEmXtg~MP_+}{^sPu!o>DFIsVGb`g(l& zuB`t4{N9}=-T(jv4@pEpRCwC$-7#g@`2Xn(*b1A$_Bp{F~< zOK!~p*P*lBC0m#4RMbX(!7a)Vptvl)si?DLJ0Mx)!H6L>g?*?RM=T}94bC+sQj&wj zd5HvZ7)p;#o0RlLBsci#)1MnafB?}&4oi}>xnyH$;f2i>k+Q6GdkIobN7~DflI$gy z6!Vr90Rm(#kh`W^m6cxB@TywK-5y@+Ag{HMyVqUOsjdnTAWsGPMx@TcJZ&6E(hp1W zq=oNNHQfEz5mNpyvmz^9QOsLN?HIwy9S|TufB*rqh#aP0i|0qm>DS`v7kcjrl-i`L5gJfq3kO$@ATw?}p`65#kObvgp;s za9UALzs@HO?oh)adQUwTx)<)N?Eyq$T!ACwp_`%np&jn34DEkWM1R zxUTh&r*+OeQT)d6?Ezib8c5TQkeWS5>@zPy#6J1ds6~i*dCV@v6N-?@4tI7<%hW~; zyLO8N^?oZxtO*Ub$&Rbb68oPcqB3`DbfjHfM*rO{GBw$Dgxu5vd)U~csJeVQyYS5z zx!&P>=hoRveI)1_&O29ROpcz{CYJk$IihocTt|pGq+e=7D@Fp-wYye#s*i|gD?Uvk zV^2Ke2@#{l?_|7h%qXs|W1o>1Bm9z%1B+`QpCmtQ1^;VFq8Sz0;%Cifv$dEh@?N0t z0s;gG5FkK+009C72oNAZ9tiSJ@`#_eg&E|uRwsT86s`ipZ}D!@!wyn zHTxKmHta8+r6LN={uYrH{Oeh2bzK1g0;CuuyuaYPA0;;)eEWUUZ3)q4(rp*-kytr` zHy+43AlVMT(Pqkr-;5^`@pDr>k-*6v5Fiiz68m0)1qk2(0g`<9eOoZHtoKmuGt`l- z?7bflAWs@;=RD}1^zZAK{m$gD4I8<%}#w2HTz* zBz}ZnrY4d;)kl(t{EFYB zUB5Bs2-PxFSMreGYm56~C4HoMb$zh1Ac;eMKbrfy?0n3)9Uh5FkK+00HuJkWL|s&ZZ#6ET4-24iF$Jh<4ui&5Fn2iQJR1u z2*;MYr#xJGJqw~V0mDR;aLC{!nMgnZNuPj0WX#MSyP$xwAu1Cv2xJ<*KJs%R$rCVy zh!rBw>v^gxc>)Hp|C>60b3)Bmxsb#O7zELN*W6U=JgCde| f0tR%DPZjwW)j6z+jtMk#00000NkvXXu0mjflW~x{ literal 0 HcmV?d00001 diff --git a/docs/sphinx/_static/images/overviews/htmlcontcell_indent.png b/docs/sphinx/_static/images/overviews/htmlcontcell_indent.png new file mode 100644 index 0000000000000000000000000000000000000000..45ff3e774f09f6c1d9a70093d18f3fd6252072a8 GIT binary patch literal 6488 zcmV-e8K>rnP)Px#Fi=cXMK3QcS(UNP*ORuOZWdnXFTCrj4nd*_{d&hLEObI`R$POMJe#YPX*gv{cy=zPn@Q#0re-{7?>X~@KwkNi`Q(gHB_?Snx zQ@iU32Rv@6$Aj*6cY8wog0YWz^mYmvLm)^)`CX7S@)tP4w!54PL-f5KQQY-T%_HA= zdI+vT(@W)r3m_)|zy4Sm1WyPtO9;jJ^9KM;zhD4tA2K#|D8`Y~eV<1?1R%#B<&Lrl z@HK}2@Bx4NQ1JgFS%85W3NlgzOrVtkLnch{mwX5~3z&K9j*rMB7sO7{ilF2)gE$8Q zVz;{=0Yv7fD0ez#ho4Pk%YYyNCFSZ2w!5g*`JSV%4k`%X18Je*K^HJX29R<9^bn}6 z%!=i5xm1SjQn4c5Xp~D|z;>lv=AVi88{%W}#j87qkv2 z(hUJzG7`2@Pm;Z4zS&x-iSIO%z54D}J4s$L@&1oZ@iBitNs_rFsm&zGh1Pq%Q~X+p z0Vskv3vST@3nXd?!!2Q1}+fSFy^I@xbMsmU+!1I={W2|THB0$NW5 zeNvJ5`}3I0w8Ri-wrV^#n#j#uihxPW=>j^qq%t6ffFGf?awLX8pXp}OPT1u|!dUA? z@~qibq{8I|cABl{Ov@D(CKN-#p3cEvg&eS^TakbY2MlFQoGBlIR-?#i;F1rU$)h?; zc9X9YERB|8B*4G@MxXS9Ipiou`M9LT;s$(cA zZd9w)nvxAmoOm+L-`73>BW!;V06P9-8i@FL3V^aWAeB}615-exl0F4{p5UwuIv6u! z&V}$Zl*Sk&6p4E%gyKA>y4G-sy*vQq{s32D0K032Z2n=891$pGpv4|xs_Q!>ff`=R zf#%1uGJx`>cF7onl!;e#$dLj4lza`zThhR6Pxxl?pqnN@LDf_jDFdgtQ;HLMhv3fN z912r@2O677KG8nm0a$in42rKgkEG2+FsCP3u-)}k*d7&u7gDfk`kvnw7x-6h#D_Nvr9!YhEEJ~a z%8$jqwbMsz`0PB!! z&WFzBKmFNV-O=wRqtWq;V}X+yalxZp3Apx-j|wXA1!s&zF^mxKTA_Vj1fatz<799S zlnW&zszGeHza+ib{5U{N1L}0cmM~S?We+&e>-An^ZbLBP#p9?I_Qgr3XYe%OK(AVT zCZ6Rd0}|2DMaPJZ<W#An8he*(2#)h;!&nAR!DR)aI3UKXam0U=t50ad zJY@^;MUo^H9YjUa^^IJ$fMzPKQ>r)+^9Lqbd1>`1Zy_|Qh#C|(fz5(`H{if}ulF)X z0tgav6f#pcWtcSqTYv*x3)c9Dxyt}GMmy{M^-6|U%nGGa;Zfdd2t)|^tF2xy(;ABJ zH~P5|@Xq9J^fZiePha%wZ&mai&z2YZIT|Ay;saP~INk5{vqCcg8I8A)GZZrm#Yzo3 zC%uYJQbafaIS#?K%N{T_4F<7S)^Nfmu|%>*aezPJvBwvhEdd80 zUk)Hmm!M0T!DH%mF^2hh1>Xi{0TY6c>-hR+qXIfmz;VbIN-3NT!)D7pd; z9G?x|=4%aIXu$men@*cm)+qFf>q+tw^EF0D=Z;Zl@>a8E&yNS311#6rP&%SW%(3{t zT2c{PK)@Ttqr9VIbU46Kj%z?M&VhGqqdZsQq-{nDUVi@{_sI{SP1G6=;MTmODMdh+ zU3GeIgh7fF!Tj-GKQ2qgOahvFM1xGH^sB4nh}}}~a>uwpFteZqO^4`HN) z<7w}$nP>L@;2s2MTYzTbQYnGpKqYPsC)jeYFYUCB*S$_TR?_DJ)fR;b6f!j zE?aXYHw50a!+khF(gR>8Be(i{ zgTY`eQtokI4%j&(AZfbI!AU1W1}0g*Ts;)&jymOxpP~X47;G zcan{zf=n7kWT0BFo{CAM$liaSBH(woRuJBp2oTg%o{mtql3uTpjfpaobgWw~UV*D;*U zt{*hB{5m0Lsv-cl`fJk{dJ;Amg2wuBiN)RWfCF$#{UEscY+cHwn6cGA5(LDC;2nE< zy#6f1C5sHf@cKdKbil-h^553+@%n|HaSb?dRi1srMkL@?0i+^8irIuYzR1u5R%OV6 z2u3Afc>SPF5PBXFYjC{p>feS03gSb;;({JNRs!1rHCr5y6TpUnw;pt%gf9R zP^e&V0AonF+3@TZ9!u2~?!@F}pWh-WRXm$}t!gs99aH$02Q$y(woRuHX%LNwE zOew>&u_7U`#sw>8`h>!3JsX!09x7jT=X6l5=}0-q5iyyp9iT zJ}r>`z~HJTt1}}$A&iv+DreQGuwpqYQ_99E16>oUGWNv<#(hG*EtSWL1KKH>&&UyR z@kaIg5}N67FA@o5Xjrv)lQvRSQGGczQ`bCJfy zvHFA}FqzlsqX3GZb~ei6)B;&A%6-Bbi#jAi2z$q48v>03JIQhN0x~KpzZ^3T2o5x^ zj^9G27O29jap8bU4i-;dt29vBZYBy8f1BBH>_g#&Ep0pmB0MSJHXpSZLN6 zBM0Q<@lMj|silgcKOi{JhcU;7jSYzd8AC8;8IYAy7cQ9`aNx^1?vsuyHoR7o2RlEi zc>@-yCxpM_=6KBh0NdObLy(~b%k|?89H&nxA|oD}y=E-x5nSw{>0`RFyS zce>Hqpse`P|KnL z)uMl}EC65X5$~^tdVO-#C7ZNEa47q)Fx|Svt+OU7aYq3_+Ka|YV{8cQME7==)#}4(EejJ}2dumT5+Sg~v7-xs{CPo-07gujMMAZ7U6y-@A%H9tV0Xm<00e(+ zI>zDx$}QRcL`tRN8k({gy;g)Qd%x{&n_{8u9+2S=xXL?)19lJ~CI~p<-JF%JDgg$N zl`Yppp!=`TVi2PVx;hs|WPq{*rnDO<`H{Fl3y4@7PCL+m0iuu70^1YJwpWPDfUZB4 zIG`IgfN9QTSFL~+i(Brts0M9OD;>c|ODMBIR&}5WWS_Zm^}7HAUFL)6mY!tz10bug zg%A=MK&|&c9g-2m&tNCIR$qpWhzuB@)<{U`4-Em1cH&lzXqhHv&7K>Ok$spBtqf>1 za8|)|ebJ>;S$C#ec{ybz%7878XSxbdof%b# z=p9Xcp<8X|oj*o9vjKr($8V|!5a>m=!AMy{NJCr99{|;zk6S}!3z(4vplE2?$z+3o zr5=p`Sn!Qgw6R9D)feo(1U<={}Ph1>9l-{7aoVvi|kU6nM;)j6qjYF@%F$z)voO8>;*i*>x zidCxs%>lp9RN769O25~6!X8zxHG^Tc!1NrWp_xGeaHEHI>4xgNmI46V<<++NM7r9J z7=u`Bh@KYsT!gzgLFqRP6a#6H$YQH*bqpb5Lkz&r_X|8&w*HQ`eFQ|zDjTxu6(B29 z%Iu092gMogAlwcB6iN}&F-|NtMC}h~YiM|8`UNo8Yu8x`4*&oOU>a^KX!LrjVWt|U zY=N9+s$iLK#S;5B-Op-HzSt~RSVO)qJ_cDD0Ib135wGV;SO#2TjYni$ncvVcw(wc4 zwo|r1pLVmo*-DaRD9o4Z@dkM)_|nZ0J4HIs`LOXM=L){Fg_-K~9A zpNA*4ofe)fB^M`qI>!OFOi^esiyBLb%d zT3Eyo@FUEubym0xh#fTBTkR*wOnc|$3?G8p2_GRTt(+5=7phC_O6@QA*yZ!R%k!56 zUTqdi*{Dzp(1!BX9E%iDFop05w zccO9)=ow2iKn!Gcll{8t#!f9Ei&fKs6GD@yM7w<2jzZejM0_n{0H`PF9BO9TrNwi_ z=+bm4?;eO$c)j@jX1M@?8MS#rh|fMc9MI_;&>j(>ORSoRkEB|C<4W2;`AJ=%Yt6`N zNQgy7X#7W;to9NE=*I`(`D=bgLNn0@I zQUXM;U!WIBOEpXjmI>@k);csVt`)5>AZcTil_gVAE1I}~#v_msgRn4-i+Y-kI*nkV zn2O@i?)`cQAe<;rZkO&$0BBn&M})z(7M48){1E~cK|(zQsI|a|kx5~u*q)9*Gv_sc zOj?1BHE>9Z29Y2krZQwerqYa1fJ{ z1q@)kVwZ=Yxn8u-NEVZVB%=MHu^QluG-Lsh)q+C|y+{ud(HcAOawIG|*MqhxikTyi z*a9~MfHX%0wwaUVKzKTyE2yu;V`EsV1-HZnBtt@H1~SvIDI16^6@1u9KcHRRvxWe? z*w9=N#$;X4rk>qE8$AUGQz&$riUuYYB%|w$><}Cd%e|zqFmw&ln5A^vny`3y4sLqK zL9th~p>y=;rHwEp2d))@tr&qINrgkJXoy=5LE1T;v$8Xyke+G=_pZu*g3UHTdK`J`KaK=9A`t z>+xaR%lH?tpm}O~!4#eCj>Lx1JfR6>g+mgZqzx95o5g&e#L zHR{?fcfw%5=1VDHmJGz4QnOnU8)7OWp2-cQM~%R=LP9g&tZ{mnR}3^dM&`9uaqcC0 z7Jy9j(_SPepA_F#ip=(GSxH6WWdB?~c1_tFF&PM<(14u8)a|;fjKOf0RWh10T-*XPo zb*vAn>4xHfQ8QzV#08$*)N2q1J0F}j-}0{^Lu_;)0~uPtWI>}w!UG}&bh?sUFDA{3 zv`IF;(nvU9PU1mV$N;Kq(S@lQuip^KO(Obsz_*^E41`s+W`^ydx{i~%79EhxV?-1E zG6#o!R#IV9Tj1p7L4m33IJvG?5ICFkT0I%F+%$yqWgwa@HwrH=zVuKOHv4A{EGSHM z)vXo`Jk>bIl z*?L#A!swJuEL#o^ie-5}Fu!gmb=@qJ^#-6x1oT}wTFwV{!kJ~QzPFWBWPt;C6_vL y(!0yQ+%Wo0w0^qzf7rYWF8?XFPXv4-;Qs(VUAkhzZ?wb!0000Px#Fi=cXMFIi@OpXLH{xo~21hU2i`RxS$0tD99)YI4m0%ioxGR$e71Ok5i{{H-$ zxCEA#l%jtvW&i*THc3Q5RCwC$oxN)uNfy8>Im`d}n4YpT0{Q}5N+t5?9Ck|5h5WOJ<9r$YCej#e`J=-l3BiHmVbUKZU6n$)h1@PzlhGZlw?HZ?TotGz6q9M zb2jX(|F#pB%Y)gl)6rEYEN2xg)LZX_<ftVYp~YarSsx=ZBm@{iauRFxEMX5 zvto07m3ewc{`~b~oyPk#=@Y$vBE$B^a&IzF2diXZIsJXWd+X1nKt?hl&UPm(nti&n zu}T(B0J^oct1=Jg??UDCvw}D3y-!ACx{wnq5ytuksJXOWaJ(_H@WZo3V#jdO#CD4c7&Uf2>`3_ig0oC!A zWt3UIH5TsM0?2*PL0EmR4o0B4v8uP=%J`Xd0Udi07Vw79m66&z`Sgvc``yTRjATFG;b|^$HIY#PJ-wG%n!3HT1H?m zgP&oEWyINw(^&=b_q@k(;&kD!A!f1P@^#d18y1yiu}ZOgnm{>SsFsDa;9If~lycrI z3(c~WWkdh~R^Gg;S)d8a!n&(;u%x?aB}u}li`FGW5$ZfHpu3;X(;Nrng+N`MWoq&? zXC8BN0hYz>0{ODQM8aj(N7yj>GFhNm#VC@gr;#O{+b@|Vvt*Xcl36lKX2~p><(pu^ z%o5y7khQs3>x=I1>hM+e0}z6jISRv9%Hr$_LC-!2TRDrf)tJ4IZ}sUyE?uZo7D$H0 z>1}9zF)Z3lvidw7SzpK;i|*?HNT)tp#O|Hz>92(af<5S(1=C@n6j+2ZRf8GiVMB6f zET)AK4)S!zqJ$C+Aautfl-WLLW^|e^rK-JS7KjF%IxFicbr(C%(-h=s?6|DUbz^49 zESV*@y7Ja^to((c1q(zhuKR}J&0+4X zLQa^CfK6HKdDiF4?kt-{8H0_tAG>)44!zz!Y&`g?TzR!8p!VP8!69R6HfOmn?4^XL zXEAP#c9aJ~hhEd!)|Qc4S6&gl&|OpAz@Ov7>ues*4c2M~gbuwbAXLyAS6=I{itfK3 zp70K=_B|(E6i=DOdk03lHLkqYA5$ntY2gNqFg(XudFHU_-&1CB88_Okapkpss>YER z!XYH*lItuh%~=R$ikn(jUW~*??OD9;Vx%wN^#yDpRq4vB9eL6Hk90Tq0%)G@mh!YZ z9qRR^&Xreybi-{0?_xbwh`prPlx^9GoSgwD=ud>aM7R%w#eDHso9`gIp z?aQ4h>3=%P;UT|u1nomEu8rl8Z=yc<@_L^`&3>7MNi?-?P>FUqubM^O!G7?4r~1R} zYnG{b5B2fTt0i6|%aq98d8o-~ICW`3Aq$hJ=#E7d?6&!0i#y+Z(IvPoCoWtl1#d3>lNc$RYYXj{oZ;3uktRa^UX zF*W>DN#48DCVh zXo@lvWKp?({dU&<^RqAkmK^wWcvPssZ-MBbAsT}($AJMmp_S2IIZ+Jtrf;`0ZxY>e~%f!)1oW+PNIe^OkkM_;`HcWK_#yWTaW7 zgbpmri+AsR*VMwa%SWf1<2~B4GOAA(eacWbTV(lI&0N3H9CKwl!=b>&BwkPegYwpU~ZYA}qX~w^@$Nhp zGaTmE`m2@(m4?e&uqgSA$}%#JJJE1hGu`!WKTUL37QAJB(L>$QaG1^Fq}O}r{x*_5 z$5d=VwDw^{>G)&br0l1fSsJr+^*p`~)8&t>FPSB?WR}d5Su#sz$t=rnV?t?4`^<*d zKGkrcXH+f5(h3b1W?A$q<{0(Jh2Wtl0oTdmr?giNW1*VL?x(T3sWo~)1+P;^!Ibuz zVXR;TfP(2p4u>xf6r_=w>7u8Dxe#{r6rY!oyJF2SRyb6zGSo2u?S`ZK}tqH+Js4w`v#*!fER@ECL}If+LeI*h)tA!&vB-oWQVr zF@gwKe6|k!j$SpNQfo3Upiuex@b$#;00N5;rqbSWz;bXw;4#! zRY%)WG1ZEi!mj2+(@cGj%V0rU!K!(`5I(9<*ysDftU@h^#Xl1g?ZPBM9S0OXA<~rR zVp%NIkY$D*Ie=G=a0H>kgjnDw+43=aW=Fmm6H| zpgPGYY}ZXx8%Qvoj1Ex`Sk-tzR|ZT>rMnT85*LtV0a-dEq+1%LrAt9-3F(lM zQo8)%`+a{k|I9phKJ(1n=gvL%oO2@{Ya+-=8At&D0J%C+RR;jT!vX;KPY4NaT3S2G zn{G~c-Z}_nz=t8G&6_~#KdlSukBsjRboyP_iU4R0;<_lSQjNb*$_8~$08iKy*R z8mPok2Eb(v0**FRw0ui6Cvsi6 z%`qe#YT1a!0Vp8&s=**I9=j4DG8hI8l-pK0w^;RUYu(c#Xt%%if&H203jcF4rgYs| z*m}sE47t9!(eT{)D{=n1X~=1tBKhivZ9&uIS@-TgS0w-BLH|vgFF|?7?s&mi-ACQhj0I?V3inS zZDv#mIjvXx`(b|*z6PAJ7Ea9l)7WN!3E1`#b(5?wNA_MYzJQ0ufZ&aJeIGT6SM036 zV|`){Kt<3?fkH`jOOk6#*M8eLN;QK25tG zYn@J^1tt`y1z8^r+B@vdA{pJw8HgmkR}$}-l?54MbPnI0Pq@i@sIpW*-&QKhwsXH@ zjp6uGKVUcQ{OstU{M`_uaSGC-iP704ug-V^$GvjnXbF5ic7~KPIX)R*h)x@nR%s5o zr-qzZIE<%16$}t1$oiqnpV2yrfIBP=NRTCG_i3fr%_9r?4I;AVc6dM$bM7?4ors{0 zl=ZhQGNc8s-jffC3u>q8ai{o~w%}RHEQh@YcbPx-Zdr)S+dOyMJz;_g7Gj9>1&WFTH%nrhzea&A1$Q zLC7n&@LU8GC4z~IeJaKezvD0?D;?aR;scLOQL)=T6e++R!EyS2s~oHv5X1OUQ5pYL z9-((fva6}BmSR0JTP_qP28L(p*+{K`)vHY$EaCw`b{3%QTwb5vB84eRwcgs%=g830 z(oAV{d97Db1}|m4U5D5KNiy4(k2cP}Z1ZlY@#0sno}S)=%k$+V*3Z{*7^75TrcIoO zgdM&IMg0`=H`zfdn)v$Z=p@vBXkOxYg>a=Vp9n%NZt5CW3YsM}l`0lza%Gz(xB4X559dOQdR*uwR#vAgC$=bHnw0sc$+O5)}VW!jtd;84S@hgdw)|Lh5FJn z9^Y5(L{w_`RQhgISt@_+zA_9YsSa4Xb-)w!Ab*|NQQ^h7{Dml>K^8*Z_#FX%s?-PW z@`K`sg=G*htg}5`v=0j)dDzoWs&i2UDsV+tyI4>f`$CoqBLXlPU$*Qce+;CScXP4_ z>JcjDtvB$qX+lwK>u6TD-9rdS4l$`YZZxXJytxeJkCRQjy}eq({yZ)J&6gD zaHJM(elk5q90A^3=Oz6hcUktCY9ze!v?yZfvZofBVp|qI(OS=;={!0UzMjbJ7H>_- zYqm%=RTLya^M!iTdT_Uv+ZFNR%-*lNOW`C92`i91YcU_ ztW*6qatonB3#jV?G&yp`gL_%6iU}9nifx`p^sc zivF}n^b)ISiPAaRww7+QO`82!4ao|3D+xi028M1tVx?6*p%ca%Nuw*X+|q6L@s(2N zdD@CXev72R$(spi5Wd^S^DYO!V0BFN8D_&1HqQ8o{1?&tDwtL?_aHOh%)+UkA{i%@Bi6Oh#~Be^9d1u`gepQ>Of3JOeBT2{7+!T|ED7(4{-@T^4)q znW&Q0LK`dukn_PsQiL9K50nWNO4?c?ZqLe~5^Adpr{*N0J^Mo!#H!sE?(dhRatF1L zmF6BwA_Vfrj(VP?#hSmaG$|`t$gT|eyyiXUgLOkK3IMlbIS^ITs@$0BhL$dw>6w6} zck%sKh6?!YCB@xn{m9YwD(l=#hKJFN^nv;;_k_}39DPgCpR&^!9DP`XfE2jt-*TFF zx+;NuO3O^(u}vt$t`M@_ZGYf(hQ{*0uJGc>#%_`tsTWX=93I}|TgjzXE*LvS3dO(3 zmx5%8H|Z}z&Rg_x;@S)skXKl19jg9t!og6N?nrH&c=MjfyZr2?TBGo_2yKBXe?Ie>U?UvF?T9lxqngp6Vr! zB|fnyt`>3f9Ynv#MaICQ1*4MsCAB?vgHch1YR++ogLIqpptH|=v)Mv@5)ykfR+ugU zKF%6a!Q!qHS_HLDjNx*$7gw=hJ}n2Z|79a7-WX!etQ6@!$0p2BgM zaV?~fJ{84FX8jO3;#7V*rNfm>j|VQQTdqjvxAjt9jWm47s1X}6SxCi+SiS-JfDU&U zd$aRs4p&*f9))RHvPIQ7^-Sz3cX@G+BjB|!XQHk{L22Hl>C7rzAkkkFHc*SdOM=|e zJ7=^CJW0B}oc@!zal)y^31MY2vYr<54Yjt!y7N^fGGXe~^t+_18q)+x^yw9M`OBEb z>FzDbJ|9geJDpokjBm}}JOMVR`ODtZ3YOb@UfmJFPyS8iZfB9Q9$0=7^5g1ZCe=v`WCG!sB+1&5|&9)Pb3k~7py2&*N> zE-j*12FM}TyTgRPiWM#0vNq~)BtnLQ%r367}Tz4??!c=DFj1PU^Q-*@N~fNW@mdI~x`-e=aEhmx}dKW3?7!eT4tv zJD(H<`u5UglXs&tVF9yQ)T>{Ly*KCoY6@Q5nk(do>(=Tnto9KE+>t6^! z0}iNfD3I$XNk8HP=T|~hXH%O`KZ(|tBG)e{p?}F057v?=*~|Tgi7i|cnZ?GW-|qR^ zQ%}7a@Jg8?8~r#>0S@(*rITX(ZjiTfMP9-l`%*|}{PObqkEs;r+!H+6g=2dHPo@-~ z|70kGSjdo5H%a*s9eBPnz>1WIoV1-d{6q7)L=4(=z!!-UmcS}vPjVr&0^0cn%mrqu zLS}VmnZca33g}5Lf)+wMqf0HE!IPP0XMot3_Cl}y>O5L%ZqpbVLZ5_ulC?NnJVPzu zAX@G)mwA1b`eekGMA+IhvFg==F$a?6ndJfE3ffEa=WCr?TPw)bgO$D#n&OixmXu`p z&lV>ePmH0N&x#Pt)Wq~`@d&lxToK^F^K`HI9i@Ob*l=BdRo-IXf38^A63;sd$?C^M z6NL@YzC*5DR+uS8?CE-~Qc&)*QoK72j`?Fr3SOs^7?RZbGh9o}(sk6HODtXoTAq1^ zO?~Dik&{fZIp{XNT%~O$$Y=*Mm8u|Lo(aTSMzXlY!zpyZlMbbj4+;QBf{@0}s0JEO zimtkCh<9gRMqhH@G6%TpD45tY`k2hdj&9RZjoIq$OcXbG@C_Tigqc^*d!w)0>)bz<I3K$Ex<+eW zGY;-qw2L968YB_4PHJ~BDIuSXVb#Y6-;&f$Fl8_$u_Swp@;%7+8Ve7sjAjqOUV`H{ z*hFp=)ydQ~QGmY6naB0GaO-*i#RyMIi?!^(hHcEzmhmh*tXkSckii9ErjHPyue~$VIbp6hO+qOp0?pc-J!sK1b$XKh0JnQ(x?$#Q(c>HRg1gr&gX@ehvCqD>u1Q4ziZfj6{3vJCDs#%P5pM+67 z0Yqkguzm!V4s6t>Fab{ZR(_M*PtkG-VtNfjt0d^@mrBC z&&09=4R=71iND>Le?7SWm6TH9bheL-2C%y;Z?--nXSB1eOmXwK`@*WtF*J|lhnt!? zcbcss<9$H9&&)qKN+|OC!(yJWR!D2{gh43_(sHJ%*LnC_NbmaYetp7!pp7aIh3J3$Fe2E88EV^q8;QVdqyP&26Za zk6%s#K>08@cC~Ehq4bN^HyKKAuY)HN6-2pD{3dTXgfD%M+#cY%W@tFP^*rHktyBCI*>wW%ws=QdlH19IgGCZ zd!-QSQlxF)k7t)_^6nJ$n@!a(kl+UXUK)x_B4drP(IAhIV{LyEvo9|7#VI3oiJ1(9 zQ@M^EqT-WgzAR(Kd`@0lyi?^7wD%^B8gSn#JOEgPTjs$ext3M^vi>fbtj_4NmmOoH zAW&_s6Z-L*X-Fju5fRN-*~FcTwhNecysl z`!p&7IY(*wgnmy=3Gu9yR6t^Bg%UM_`PZ2Fvxs2u7l+wnsc%O!^Fjv^$R-q27OuPL8)SiK04X;-K( z^_cQ-MzHB_yC3k!EcIaG?K6FF^kON`&TEH1yVugvCz^AGNC9j`P-kmF&;kqE7ck38 zEJT)d5j3~Q^Kw-ETzCF*jU{i6=fUumzW~;}@PpZ^$baPY|A_v7#CjJk7S16m)jol_ zXXZxqlUp5#GW$NNvWc{CzmOyaAcf4F9pWh;j8hPHbQ{Csa@Eh+OUjd(%%=9F`VQ|2 zLkAT?QkFNxi}jNjz{=@L(w?MZf}UmQ4co1hm-P+p3S=2T7`6pY83YH zjJ_xvhD7A{M;qtjc-gq1YJ)P+V275%rv>y;?xv7x>FRw3{L=^h2VoC{TH*p)DlLL) zM2&MLQ-<<;oQ*v$g81XUmjFPKe7A33#+~1i8oR}v@6KyT!2Vnp8#WR)kasA^r=Dw@ zzyyR(`9PF5*laOM8VBU&aCX4jpKqPyt5Z(du(zILdie1^!^h+BE= z+%B%~mJ_%2F(xnXQAyv<0T9in+5P_QBb|n1zG6bm+ercNB}?Xsv%F7r zXVcGGo7TY(hLEK9%yUQud~K2XJO_O)%NtdYPLmrx$a@Ik<9(v&8=or$*;o2mbaYU? zMEIK9=0c9j4-85fpI|6OK)|+rcUgrrAkw%pC&gS~X_JHjEo_{c18eP)zy0?bIz5A{ zz6}$0XeZ?ZWeRU;8HT5j<|EA3HpuR}|TM2RppTfZX#hNqt_(`2NOPDn69z8ZKCs5+ZD$ILwph%e4t(;#uq| z4?8d>Fq|fTocG}LO0$=U8iO=qt!2?7k})`$oU4N!)2cEc-QEqH)pH1@Y^c6_XCt7~QwTlHxh~eMkg;1{GFyJ-M`P)^<+++@jjhBiTf- z6+ITHGKY62NUOlUbrrHL+d?*SH@J(dn4R)b>`883Ixh>my4Cadj||aF6@WfPDpDP8 z{U9m5Jtb&=zx)0nu1*5?uf9+LzM(-lC0pmElqi<*=HZ>lJ!dY`K|{kNa(JYV!;DjGWYq(;})@$}4YR?~PX@UdclU{OpD8 z_PM6}qXNvLRm&wNFSbf3=KvEz@ErY( zL*L?)ostFn*lv=s`nMZ+`!HW%Tn zLH#yjW-LV2uWK(vrF$J#2$T7cj`7{{LavkkB)`tKgcL_9bHnlDR3pLlb%$mmu%LCa z@Z)h<+(0V+W>S(ri5Ja5uEXY?_?X0(pY1@DrZaAbce@r?c@75J+kZ$#X0&)+5|E03 zBFb&Vz_cl0m7HuuY{ou@pgp)U`RE1bf1uZr=-Hzu;nZC|o z?Vtmaoo|>R&zZYnzDPcOcW>djBtZUu+U3{m1ZBF6iskB>rQU`&ji9 z{aBTkooe%OY)r=O>#u6r=>1p&0-xWCDt;HfNv#G7jNRDc1<3A7s@zTXUp(6qVix}5 z7*@Z3tkwSj#wa;>`{-7t$SJu?;Yi^5qspd(j8OW$lL&nT?IqEsp46B@+W$3+Jz&tf zXRaoU1h=i4icUTPMT6FCZb>37d(!OfzGTYKg?#AyBIG=oWK}ClgCf&;dNw1$l`+&$ z=L44yrb3b2J-8(%iuvoR$|2bnAx3vFR8w0^2Au2xdC8E@+q)j!($W~4&H`kY5%&^D z;9)EdV?&ILRX(NeCuQ9#bU z+4KUw_auTtrfL<^bINDUp+uZ#0Sb5I&wdws_xg~qir{Z@I6;S1`^Qv`ju+!Oc1F}L z<%!BczjGgc1E#l{-+3SN7<*2&Y8*ZCfz-7&n@p$BAz9ZrOI0CDXSiK$OlEIzHKe$Y z>Jpa2gjG+nlr8;{nrL?otlgqoVrnfcdb(w_KSObgvz8IrgnB8Pk4j#ZfeTt>Smzj#CYHGuhxUQRKctMj-*K^iI3Iv!y*eRZY-;O@Gms*9$I zwa-3%-|tv9#_(gi?&!o)KJ$5TI<+)IZGeeyz;8aQc}^W@r9Jw|Gym#AGU}BMd*}Aw z6j6HT%hG*Zl%!U)K$T-hyv~$BNGO2R3=xI`p-528-uiS21C|@&R!=KIsbml{p5Qye z-2Aj5Bpua5zoPZjddID>Xi7^vZah6giac)* m6n_4~P7ONV*LW@n4JN;8j}1x& zs;oOX?0Ud~j@tLE+-4f=#k0C;!Mtb;ILSozD^dy4fmd1FH;plaP%lN0DYqFF&@%y1 z?mf28-#;~I!x}wZn*K54QL3hPDt@u*Ol&|=M%D=mMk1C7jbraSpiF9`LebRG+d1kz z*I<%LcA>j&L2P+iR!mSVjS~fx7uN3X&Bo9qehztU80%{3LjA|Y&(Y$VYu~>Q7{Z!D zbLYg5F7WWG8ZrNOR|>5N**RWdmTSKv9BHgz=6+Q_N`b}&?uee%B)(PZ$ogLhvw;0) zk!LL6lD1Ff%9~Bs*li=FLpljcxY-=)zwD}YSe{U^Hh3MA;%MYY0t68nj(uEHr{@w_ zm4=~1E8|R|?0F9sOJ|Y1HjT;#ahs~*3V|8}rw(D*O>wBsAg4JAxKGv5MdupQo5ve> zha`z)8bg~~#N84_%cZCKDKjr}pu0-dM<(rIvaYrx2Ol4wZ9u%B8zIOBKBo~~*h8Du z{deUa`4t}-(tgUV{boV`0DZ2g_3@~o?oW%m&2nt;a=otCCwYl?gdwvjlpZK z#MA5LBIPZB&Iis!V?WPY4NY`hK!XxB9+)b3B1D-69~h_YFrUz0#g$iS?Ci)1t=H?f zRRa*-c!Asb4^m~@fR9}nLkw7iSfsnB-eC)=fB$$cS z(_{na1aTztYsBj9$^iMsNTsKQng)#}p6(zoAQ4x|ITc+0Uvi)_uUVg*fqEKD`rZO= O4t2Pu>IdbgsQ&_|Q2s;! literal 0 HcmV?d00001 diff --git a/docs/sphinx/_static/images/overviews/overview_html_contbox.png b/docs/sphinx/_static/images/overviews/overview_html_contbox.png new file mode 100644 index 0000000000000000000000000000000000000000..fb17984c54470edcd1b8b3b8271512e96b6854b2 GIT binary patch literal 3592 zcmY*ccQ_kd+fR+OMyOFEL~TlqR?L(l_NG>2KCKZHwRx_fB=eo}Mop>`7T@XE(9smG<^!2nX001f^0C2&c ziuxS65cBHf_Yh#As|lzc;9WUa7|o0rC}LLrsUgI zuSu{z(~y{|rP(Yk=4y4TE>SWQH|hnl3V+C=))t9lJ)jzcws?0Em1R{6BT zrY$-s<{JmJLqQBWh|vrm!Ns`IBTla)@VDSzKY5f&(nFct8e)5c0|j=z{KbkNCligz zAUk>Yp>iy(Jl=X9G;F6`dAb@r4-5h>Nx!?cM8~U6T^HcC<5D`kC;4Mjm-=F^cyxq% z-2;IbP=3DL>1XI`QI;;Wq5>Pi=;l=oSg`oZimnT--2wL$=@8eE1cU}Wj*rNC$c$A^ zI?AduhjROA)Ms)cMI*TSsd_o^mr2CsC!|OKMG3@p-;n@JWJ0l(JkBZZaWJL+(zkwF zi6qECb}4xQ0o)*U^r?XQa<(r+ADsE%dDH^cd}fk>KPA-yK~kMHg{s`_t!q}wh+YsF zalUDwDx5t28HrFmTMw>ZG?52UFp2x4cEk=BvCUSVlxF524=I%;8mZn2X}ohcJve-> zNdc;u=8pYj4*}=IWJaQptysUOkkv|g70@eqT^ja7C{6Y7ynpKyRukXQMk0;=zdTXz zWw&M1Pu`JsR+s*rJNTk^!EoNvwE-V7u*wGai-+3}S}QEQY8|1bdxc*s>OD(8sHIJiZml}*5*i;!yTzW6hN7b@ zX?+>cqn;|*aS1}76#lp(1_MuYNd4~Fe9IV;{6cWSIp7LXAh1B!f8KjJZzT+C*>Ag+ zK#KU0AEbI99KtxQLSS?!BB;=u&}v<;I3`;39Xvt>$_Il!Szi$4)2cU$4Hs<$&Y9P| zOpre|Q+l*bK+TNhFJv$m!qSo>Wfsg%13o+CDQpQXOXjua*4YX10*&APWS41Rz~|@_ zPij5FH4W!qvoJFDLVR@QoV|-CbK8}5O$QJK58U&1KkSj1S_`|YBqLIkUF&%B=I`yU z^P;Eq8QJeI$wKl(amrbH>!`MKd+7L6iO-8C-;ez+0Zavni6|z1QT`W=uc|Q{n(OF^uMkXkoFi9h)gM#X zjFTU+<7Eg|oUscT5xJfHPe>*cMO>J*vh!s~zD;L=l@~-g&f8)sk>qlwRYpk(drndz zA_SS01_@xa-UtKOl8+8UgKTjx;Y(;G;#xiX2i5Ouz?0~qJXfSHBlruRhq;W#%jF`) zAz+tE5qFq1{sZ||wwm#q;p@l?NESb8C^rLGtcT+>J2YNgQ`S#C&MiTaD4R*Vd4~O~ z4A7rjD3ATcgPx5gEo*uOm&L!xM_4i<~*slhXBMDUfWZ)l)9q^B5eZwl;`sf9BtDb@Vdzjt2}Szd)FHhYK*1FYxxxSAo!Ct?D8_anAxP( zTw&>(|4zWh$U-T+Y4?mHya4^9nJ^N|9p`NGSwrWchl;>MR_l8w^Zb0Y4K%tP7e#tr z&ZWllwaIV`aYFy*Gmb4ZSItHm@0txwEUn}h8$7-8;|)*Jd@?c%vDO=110Qaz=495X z4vEBcE`e@6WePy^PC0W6=0WV|$6OUvLiP3Uf*#Pduo%(B2hpjjt#uxKsL~9U72axj z0^w>lNjkulOOcqgp#Yf6*S_$vz@KVd&Z*15a%w?-09p82#hBRbqZdpHVeRhup?CFC zAT6)uX8#ho!?SSE+)T&|mDQF!r9#T_q6mMB(eFJLHvN><=-36euzpMAUg2tQ&9+gp zRE!?& zyBu~8 z8*NdT?)f%mPd7nnB03)gR5~CMrI;fHnN`t0w}yq>Gu&oWeSO%aA?mVgJW{#uXW;Vh zd*dD%#8!UvO&^r7%3~=RkmSjiDE|>(FWubVFGE~(!tObe<`iB&b#X;+YO`g@rDE38 z#lc0ENkV!2Mjy0YEowPGc7!OZRHT=osSPui6cnSWL43TAnJwT2DfW7uOcQNombKV# z-r5agWns}g-fkwtLN=_?!Dz9ni$n% z5*_(n>Ck`RzqU?*{a;Y+(T^L74}>nqxctQ#(CcN@8zZl8BY`Xo1-^sXU zHeKV>se}fYU&L)PV)iE{E^MWg5S69mxpUx%Z;hWjCI*Wop|g&n%eo!j6`WZIYesOBmO3=T+k0P!yZzW8)F(V+D-u3k#5GbF9#Ici1GIBuT)z_|IH?KH5h%dy50)<2JsR9iGY<_-% zrd(8H&IaCRJVG)s2H(}|aE|6r_s<+|uM7qm80`q(&3qAUGxkW~ge#dln@AJ3CC|>x z#?lgZH&i&?UxUq8*7;^17k}SQ%S3a>{j_lF)28bkRx@xfontcV#L`^-iYu-ty2SM7 zI@jl$t+bR;fl+1ht%GNDB^$2DnVb|!49eZ@kUO^S*91X$eg{UJF8$KNB&EjYUp{S+ zGrp?5G82Rd7oE2d$k+)d1jpG+6j?-3ljZzS^yTR}#-=C98sUP!t^OL}3yh$_C%+c} z!EIk9DTo83FIG=1q>(j0fYHyHs~D?hwJUG?L{=qOb)QqU|MIDC(Z4D@C@5sZRA~R{ zs>^a=1Oz)_r@##wB&`O-0&6KiNMs_OO`z(+r#nG zD(&iMMsmq6MjLxx;7xc9>APcM!^(*}OIbQmAUSWJ5XwIyAOouW`FK z>D9ffN7wKT&%X|3-sYgxl+^#Xk+Vi5C1Uy1%-`lwt6;YFp$?ZR&u4P=UR@m0uVB9C z#^+-~$LU_(6C2==Q%j_MwMBnH=DsxCS9(pK45 zg$JdBkjJBg)-*K>{Eb`(I_u;;bH0~Be;}J4TF~Npm&CW-KkaDaYiPBHdkH&@R9l}R zt7~vrmzR_J1i0pFe91PMlhAOkW&`c!>Sb`=@uO{z8*YeuBEx6veYuiR|FK_Dd6f{k z%t@4R>^$13_=YY1HyQtP!r$Q)KTGf#-(?QGnP+QFgUax~8r(4`jK;+7y4(Rf*$xxA z&-*{}8XhvJ7S2k^KbK6DszEg#%sws%J-L5Ea4)#}F0@R=<;c^_vLI3?VbK&>>8{xJ zk3z0_K}I;W6d{B-FOVOF<#(r){$_zMuQ4keN)T?Yhip=xIKFAh(v6zS{}`h3BYIHm WVfxkd%$(m}IDKsst!ho@n12B|`SXJS literal 0 HcmV?d00001 diff --git a/docs/sphinx/_static/images/overviews/overview_html_hello.png b/docs/sphinx/_static/images/overviews/overview_html_hello.png new file mode 100644 index 0000000000000000000000000000000000000000..cd26c48fc3bf9074d0ed1828a9ce174d2ec90dda GIT binary patch literal 1699 zcmah}X*Ao37XK$yEK#kcqV_F`s->BRCmlpeh_xrEBPoMgs+PtUovJkLQKi;|){9d6 zlA$TBrPMZR4O&|~I~{6Tl{pzjMJpcj&O7hSr*}Wx_4nbP-(6BKx!TK0pOyvyK$hTO zO9TMWp$h`U#SRVUN~7md6hpMf0i3sLpAG}lOU@p4*3b=RPF^T+rs-`@Q+v;jwDS%r zse8R`k6F888tjW%-Q)C#rk3L(Yek~(d(?t$3xWUuB(w>(HXb);`3pYR=J09&rA1X7 zd@RghH&plT-KP>GzFQs+-vW@eH{`7pHxMjw$U6@79#+#w+F&N9C*9?7oYlCuzy#hasqzFpQc!#xh^C2n=NE@_;tyn04l0`cs6-HloE)0W7X6NjcpPZ-Jw|Oh@XC{3lqFb^83z_fOvNI=>u=esA!|YhaCy9LnyPU)4Y@THWcmw)Law#qocpa4EU# zAc-bmrNSzZQ!dj7`LQ+XJ|N=xCV`{hiBiVp6U=Y8EeX%6?%~@Hw$Bb#e=UlLZh7+i zbCxDVzzlj7j&!f2^VrU;$0XSxR`{x!GOdtxd?{#h z`uU&vBJ{5bVI{0w`FG7Hr%wqieIW^xU$;zQ!^noE|I%b?7sRiq`|f^ZrI!pNOR z=4S@1cxoWyNzh6+_#Sl%%bApw;s4_ieB_DRRXjdnZj-I+HS#a zeQA{O8&(c`cd?**F~B>HhA%u|6>G9vs<}%U*|Anb_!luIW!!lohOQX~g<=AQlPB`^ z1j;w{o^;mcCzLI3M)tR%)?ly$lv*O_>yno+Z3JAVF(@%ry@fwx|}A8V3S?SeT>zu~lW+0ma6j^y)OP)n;eJ z%4w}k%&ZOpinjCn&EGWUGQ+$ZY%rIraCu;~x~kVNc5~6;{bZ;|4a~Y$%|zcZW*QaI zDFuqeb}3lemSXw6rymzAdXw)tkr%m#QW*BhQyk>q_OmZCk*OIN_h z9jGBVY)pNa$|}!i;;GXqPGu|P#m9%QQ#tMkI==O!GMTxN^1w$c!6}t_e!&Iy88u?1 zU95dwRZ$C(Lyk(9wQPxWP|v->49$2z&(vGFN^j0Z5)|qkcCPJ6fs#Ag900d3Y(5<1 zkrv#3sakhp___6?qLhq`GsjjBO6VB&IN33`T#0%W@2ES2;Dbj(d!aS(hV!-{PBOK8 z9q)qV%k*9kU>m>`NAco*qcJ;=<@G}&-WR8e;4|t!!Aqy8I@5o<@FLW*b;G(*%g?S^ QK1U-V*tyzraDMmx4f+J^ZvX%Q literal 0 HcmV?d00001 diff --git a/docs/sphinx/_templates/main.html b/docs/sphinx/_templates/main.html index 4be5fab7..44192003 100644 --- a/docs/sphinx/_templates/main.html +++ b/docs/sphinx/_templates/main.html @@ -94,6 +94,10 @@

wx.lib
Our pure-Python library of widgets

+

wx.py
+ The py package, formerly the PyCrust package.

+

wx.tools
+ Some useful tools and utilities for wxPython (Editra, XRCed).

diff --git a/docs/sphinx/rest_substitutions/overviews/html_overview.rst b/docs/sphinx/rest_substitutions/overviews/html_overview.rst new file mode 100644 index 00000000..653842c8 --- /dev/null +++ b/docs/sphinx/rest_substitutions/overviews/html_overview.rst @@ -0,0 +1,646 @@ +.. include:: headings.inc + + +.. _html overview: + +================================== +|phoenix_title| **HTML Overview** +================================== + + +The :mod:`html` library provides classes for parsing and displaying HTML. + +It is not intended to be a high-end HTML browser. If you are looking for +something like that try http://www.mozilla.org/. + +:mod:`html` can be used as a generic rich text viewer - for example to display a +nice About Box (like those of GNOME apps) or to display the result of +database searching. There is a :class:`FileSystem` class which allows you to use +your own virtual file systems. + +:class:`~html.HtmlWindow` supports tag handlers. This means that you can easily extend +:mod:`html` library with new, unsupported tags. Not only that, you can even use +your own application-specific tags! + +There is a generic :class:`~html.HtmlParser` class, independent of :class:`~html.HtmlWindow`. + + +.. _html quick start: + +HTML quick start +---------------- + + +Displaying HTML +~~~~~~~~~~~~~~~~ + +Class :class:`~html.HtmlWindow` (derived from :class:`ScrolledWindow`) is used to display +HTML documents. + +It has two important methods: :meth:`~html.HtmlWindow.LoadPage` and +:meth:`~html.HtmlWindow.SetPage`. LoadPage loads and displays HTML file while SetPage +displays directly the passed **string**. See the example:: + + mywin.LoadPage("test.htm") + mywin.SetPage("htmlbody" \ + "h1Error/h1" \ + "Some error occurred :-H)" \ + "/body/hmtl") + + + +Setting up HtmlWindow +~~~~~~~~~~~~~~~~~~~~~~ + +Because :class:`~html.HtmlWindow` is derived from :class:`ScrolledWindow` and not from +:class:`Frame`, it doesn't have visible frame. But the user usually wants to see +the title of HTML page displayed somewhere and the frame's titlebar is the +ideal place for it. + +:class:`~html.HtmlWindow` provides 2 methods in order to handle this: +:meth:`~html.HtmlWindow.SetRelatedFrame` and :meth:`~html.HtmlWindow.SetRelatedStatusBar`. +See the example:: + + html = wx.html.HtmlWindow(self) + html.SetRelatedFrame(self, "HTML : %%s") + html.SetRelatedStatusBar(0) + + +The first command associates the HTML object with its parent frame (this +points to :class:`Frame` object there) and sets the format of the title. Page +title "Hello, world!" will be displayed as "HTML : Hello, world!" in this +example. + +The second command sets which frame's status bar should be used to display +browser's messages (such as "Loading..." or "Done" or hypertext links). + + +Customizing HtmlWindow +~~~~~~~~~~~~~~~~~~~~~~~ + +You can customize :class:`~html.HtmlWindow` by setting font size, font face and borders +(space between border of window and displayed HTML). Related functions: + +- :meth:`~html.HtmlWindow.SetFonts` +- :meth:`~html.HtmlWindow.SetBorders` +- :meth:`~html.HtmlWindow.ReadCustomization` +- :meth:`~html.HtmlWindow.WriteCustomization` + +The last two functions are used to store user customization info :class:`Config` +stuff (for example in the registry under Windows, or in a dotfile under +Unix). + + +HTML Printing +-------------- + +The :mod:`html` library provides printing facilities with several levels of +complexity. The easiest way to print an HTML document is to use the +:class:`~html.HtmlEasyPrinting` class. + +It lets you print HTML documents with only one command and you don't have to +worry about deriving from the :class:`Printout` class at all. It is only a simple +wrapper around the :class:`~html.HtmlPrintout`, normal wxPython printout class. + +And finally there is the low level class :class:`~html.HtmlDCRenderer` which you can +use to render HTML into a rectangular area on any DC. + +It supports rendering into multiple rectangles with the same width. (The most +common use of this is placing one rectangle on each page or printing into two +columns.) + + +.. _help files format: + +Help Files Format +------------------ + +:mod:`html` library can be used to show an help manual to the user; in fact, it +supports natively (through :class:`~html.HtmlHelpController`) a reduced version of MS +HTML Workshop format. + +A **book** consists of three files: the header file, the contents file and +the index file. + +You can make a regular zip archive of these files, plus the HTML and any +image files, for HTML (or helpview) to read; and the ``".zip"`` file can +optionally be renamed to ``".htb"``. + + +Header file (.hhp) +~~~~~~~~~~~~~~~~~~~ + +.. highlight:: rst + + +The header file must contain these lines (and may contain additional lines +which are ignored):: + + Contents file=filename.hhc + Index file=filename.hhk + Title=title of your book + Default topic=default page to be displayed.htm + + +All filenames (including the Default topic) are relative to the location of +the ``".hhp"`` file. + +.. note:: + + For localization, in addition the ``".hhp"`` file may contain the line:: + + Charset=rfc_charset + + which specifies what charset (e.g. "iso8859_1") was used in contents and + index files. Please note that this line is incompatible with MS HTML Help + Workshop and it would either silently remove it or complain with some error. + + +Contents file (.hhc) +~~~~~~~~~~~~~~~~~~~~~ + +.. highlight:: html + + +Contents file has HTML syntax and it can be parsed by regular HTML parser. It +contains exactly one list (``
    `` ... ``
`` statement):: + +
    + +
  • + + + +
    • +
  • + + + +
    • +
+ + +You can modify value attributes of param tags. The *topic name* is name of +chapter/topic as is displayed in contents, *filename.htm* is the HTML page +name (relative to the ``".hhp"`` file) and *numeric_id* is optional - it is +used only when you use :meth:`~html.HtmlHelpController.Display`. + +Items in the list may be nested - one ``
  • `` statement may contain a +``
      `` sub-statement:: + +
        + +
      • + + +
        • +
          +
        • + + +
          • + +
        + +
      • + + +
        • + +
      + + + +Index file (.hhk) +~~~~~~~~~~~~~~~~~~ + +Index files have same format as contents files except that ID params are +ignored and sublists are **not** allowed. + + +Input Filters +-------------- + +The :mod:`html` library provides a mechanism for reading and displaying files of +many different file formats. + +:meth:`~html.HtmlWindow.LoadPage` can load not only HTML files but any known file. To +make a file type known to :class:`~html.HtmlWindow` you must create a :class:`~html.HtmlFilter` +filter and register it using :meth:`~html.HtmlWindow.AddFilter`. + + +Cells and Containers +--------------------- + +This article describes mechanism used by :class:`~html.HtmlWinParser` and +:class:`~html.HtmlWindow` to parse and display HTML documents. + + +Cells +~~~~~~ + +You can divide any text (or HTML) into small fragments. Let's call these +fragments **cells**. Cell is for example one word, horizontal line, image or +any other part of document. Each cell has width and height (except special +"magic" cells with zero dimensions - e.g. colour changers or font changers). +See :class:`~html.HtmlCell`. + + +Containers +~~~~~~~~~~~ + +Container is kind of cell that may contain sub-cells. Its size depends on +number and sizes of its sub-cells (and also depends on width of window). See +:class:`~html.HtmlContainerCell`, :meth:`~html.HtmlCell.Layout`. This image shows the cells and +containers: + +.. image:: _static/images/overviews/overview_html_contbox.png + :alt: overview_html_contbox.png + + + +Using Containers in Tag Handler +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:class:`~html.HtmlWinParser` provides a user-friendly way of managing containers. It is +based on the idea of opening and closing containers. + +Use :meth:`~html.HtmlWinParser.OpenContainer` to open new a container *within* an +already opened container. This new container is a *sub-container* of the old +one. (If you want to create a new container with the same depth level you can +call ``CloseContainer()``; ``OpenContainer()``; ). + +Use :meth:`~html.HtmlWinParser.CloseContainer` to close the container. This doesn't +create a new container with same depth level but it returns "control" to the +parent container. See explanation: + +.. image:: _static/images/overviews/overview_html_cont.png + :alt: overview_html_cont.png + + +There clearly must be same number of calls to OpenContainer as to CloseContainer. + + +Example +:::::::: + +.. highlight:: python + + +This code creates a new paragraph (container at same depth level) with "Hello, world!":: + + myParser.CloseContainer() + c = myParser.OpenContainer() + + myParser.AddText("Hello, ") + myParser.AddText("world!") + + myParser.CloseContainer() + myParser.OpenContainer() + + +and here is image of the situation: + +.. image:: _static/images/overviews/overview_html_hello.png + :alt: overview_html_hello.png + + +You can see that there was an opened container before the code was executed. +We closed it, created our own container, then closed our container and opened +new container. + +The result was that we had *same* depth level after executing. This is +general rule that should be followed by tag handlers: leave depth level of +containers unmodified (in other words, number of OpenContainer and +CloseContainer calls should be same within :meth:`~html.HtmlTagHandler.HandleTag` 's +body). + +.. note:: + + Notice that it would be usually better to use + :meth:`~html.HtmlContainerCell.InsertCell` instead of adding text to the parser + directly. + + +Tag Handlers +------------- + +The :mod:`html` library provides architecture of pluggable *tag* handlers. Tag +handler is class that understands particular HTML tag (or tags) and is able +to interpret it. + +:class:`~html.HtmlWinParser` has a static table of **modules**. Each module contains +one or more tag handlers. Each time a new :class:`~html.HtmlWinParser` object is +constructed all modules are scanned and handlers are added to HtmlParser's +list of available handlers. + + +How it works +~~~~~~~~~~~~~ + +Common tag handler's :meth:`~html.HtmlTagHandler.HandleTag` method works in four +steps: + +- Save state of parent parser into local variables +- Change parser state according to tag's params +- Parse text between the tag and paired ending tag (if present) +- Restore original parser state + +See :class:`~html.HtmlWinParser` for methods for modifying parser's state. In general +you can do things like opening/closing containers, changing colors, fonts etc... + + +Providing own tag handlers +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +See the :mod:`lib.wxpTag` on how to provide your own tag handlers. + + +Tag handlers +~~~~~~~~~~~~~ + +The handler is derived from :class:`~html.HtmlWinTagHandler` (or directly from +:class:`~html.HtmlTagHandler`). + + +Tags supported by :mod:`html` +----------------------------- + +:mod:`html` is not a full implementation of HTML standard. Instead, it supports most +common tags so that it is possible to display *simple* HTML documents with +it. (For example it works fine with pages created in Netscape Composer or +generated by tex2rtf). + +Following tables list all tags known to :mod:`html`, together with supported +parameters. + +A tag has general form of ``tagname`` param_1 param_2 ... param_n where +param_i is either ``paramname="paramvalue"`` or ``paramname=paramvalue`` - +these two are equivalent. Unless stated otherwise, :mod:`html` is case- +insensitive. + + +Table of common parameter values +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We will use these substitutions in tags descriptions: + ++------------------+---------------------------------------------------------------+ +| [alignment] | CENTER | +| +---------------------------------------------------------------+ +| | LEFT | +| +---------------------------------------------------------------+ +| | RIGHT | +| +---------------------------------------------------------------+ +| | JUSTIFY | ++------------------+---------------------------------------------------------------+ +| [v_alignment] | TOP | +| +---------------------------------------------------------------+ +| | BOTTOM | +| +---------------------------------------------------------------+ +| | CENTER | ++------------------+---------------------------------------------------------------+ +| [color] | HTML 4.0-compliant colour specification | ++------------------+---------------------------------------------------------------+ +| [fontsize] | -2 | +| +---------------------------------------------------------------+ +| | -1 | +| +---------------------------------------------------------------+ +| | +0 | +| +---------------------------------------------------------------+ +| | +1 | +| +---------------------------------------------------------------+ +| | +2 | +| +---------------------------------------------------------------+ +| | +3 | +| +---------------------------------------------------------------+ +| | +4 | +| +---------------------------------------------------------------+ +| | 1 | +| +---------------------------------------------------------------+ +| | 2 | +| +---------------------------------------------------------------+ +| | 3 | +| +---------------------------------------------------------------+ +| | 4 | +| +---------------------------------------------------------------+ +| | 5 | +| +---------------------------------------------------------------+ +| | 6 | +| +---------------------------------------------------------------+ +| | 7 | ++------------------+---------------------------------------------------------------+ +| [pixels] | integer value that represents dimension in pixels | ++------------------+---------------------------------------------------------------+ +| [percent] | i% | +| +---------------------------------------------------------------+ +| | where i is integer | ++------------------+---------------------------------------------------------------+ +| [url] | an URL | ++------------------+---------------------------------------------------------------+ +| [string] | text string | ++------------------+---------------------------------------------------------------+ +| [coords] | c(1),c(2),c(3),...,c(n) | +| +---------------------------------------------------------------+ +| | where c(i) is integer | ++------------------+---------------------------------------------------------------+ + + + +List of supported tags +~~~~~~~~~~~~~~~~~~~~~~~ + ++------------------+---------------------------------------------------------------+ +| A | NAME=[string] | +| +---------------------------------------------------------------+ +| | HREF=[url] | +| +---------------------------------------------------------------+ +| | TARGET=[target window spec] | ++------------------+---------------------------------------------------------------+ +| ADDRESS | | ++------------------+---------------------------------------------------------------+ +| AREA | SHAPE=POLY | +| +---------------------------------------------------------------+ +| | SHAPE=CIRCLE | +| +---------------------------------------------------------------+ +| | SHAPE=RECT | +| +---------------------------------------------------------------+ +| | COORDS=[coords] | +| +---------------------------------------------------------------+ +| | HREF=[url] | ++------------------+---------------------------------------------------------------+ +| BIG | | ++------------------+---------------------------------------------------------------+ +| BLOCKQUOTE | | ++------------------+---------------------------------------------------------------+ +| BODY | TEXT=[color] | +| +---------------------------------------------------------------+ +| | LINK=[color] | +| +---------------------------------------------------------------+ +| | BGCOLOR=[color] | ++------------------+---------------------------------------------------------------+ +| BR | ALIGN=[alignment] | ++------------------+---------------------------------------------------------------+ +| CENTER | | ++------------------+---------------------------------------------------------------+ +| CITE | | ++------------------+---------------------------------------------------------------+ +| CODE | | ++------------------+---------------------------------------------------------------+ +| DD | | ++------------------+---------------------------------------------------------------+ +| DIV | ALIGN=[alignment] | ++------------------+---------------------------------------------------------------+ +| DL | | ++------------------+---------------------------------------------------------------+ +| DT | | ++------------------+---------------------------------------------------------------+ +| EM | | ++------------------+---------------------------------------------------------------+ +| FONT | COLOR=[color] | +| +---------------------------------------------------------------+ +| | SIZE=[fontsize] | +| +---------------------------------------------------------------+ +| | FACE=[comma-separated list of facenames] | ++------------------+---------------------------------------------------------------+ +| HR | ALIGN=[alignment] | +| +---------------------------------------------------------------+ +| | SIZE=[pixels] | +| +---------------------------------------------------------------+ +| | WIDTH=[percent|pixels] | +| +---------------------------------------------------------------+ +| | NOSHADE | ++------------------+---------------------------------------------------------------+ +| H1 | | ++------------------+---------------------------------------------------------------+ +| H2 | | ++------------------+---------------------------------------------------------------+ +| H3 | | ++------------------+---------------------------------------------------------------+ +| H4 | | ++------------------+---------------------------------------------------------------+ +| H5 | | ++------------------+---------------------------------------------------------------+ +| H6 | | ++------------------+---------------------------------------------------------------+ +| I | | ++------------------+---------------------------------------------------------------+ +| IMG | SRC=[url] | +| +---------------------------------------------------------------+ +| | WIDTH=[percent|pixels] | +| +---------------------------------------------------------------+ +| | HEIGHT=[pixels] | +| +---------------------------------------------------------------+ +| | ALIGN=TEXTTOP | +| +---------------------------------------------------------------+ +| | ALIGN=CENTER | +| +---------------------------------------------------------------+ +| | ALIGN=ABSCENTER | +| +---------------------------------------------------------------+ +| | ALIGN=BOTTOM | +| +---------------------------------------------------------------+ +| | USEMAP=[url] | ++------------------+---------------------------------------------------------------+ +| KBD | | ++------------------+---------------------------------------------------------------+ +| LI | | ++------------------+---------------------------------------------------------------+ +| MAP | NAME=[string] | ++------------------+---------------------------------------------------------------+ +| META | HTTP-EQUIV="Content-Type" | +| +---------------------------------------------------------------+ +| | CONTENT=[string] | ++------------------+---------------------------------------------------------------+ +| OL | | ++------------------+---------------------------------------------------------------+ +| P | ALIGN=[alignment] | ++------------------+---------------------------------------------------------------+ +| PRE | | ++------------------+---------------------------------------------------------------+ +| SAMP | | ++------------------+---------------------------------------------------------------+ +| SMALL | | ++------------------+---------------------------------------------------------------+ +| SPAN | | ++------------------+---------------------------------------------------------------+ +| STRIKE | | ++------------------+---------------------------------------------------------------+ +| STRONG | | ++------------------+---------------------------------------------------------------+ +| SUB | | ++------------------+---------------------------------------------------------------+ +| SUP | | ++------------------+---------------------------------------------------------------+ +| TABLE | ALIGN=[alignment] | +| +---------------------------------------------------------------+ +| | WIDTH=[percent|pixels] | +| +---------------------------------------------------------------+ +| | BORDER=[pixels] | +| +---------------------------------------------------------------+ +| | VALIGN=[v_alignment] | +| +---------------------------------------------------------------+ +| | BGCOLOR=[color] | +| +---------------------------------------------------------------+ +| | CELLSPACING=[pixels] | +| +---------------------------------------------------------------+ +| | CELLPADDING=[pixels] | ++------------------+---------------------------------------------------------------+ +| TD | ALIGN=[alignment] | +| +---------------------------------------------------------------+ +| | VALIGN=[v_alignment] | +| +---------------------------------------------------------------+ +| | BGCOLOR=[color] | +| +---------------------------------------------------------------+ +| | WIDTH=[percent|pixels] | +| +---------------------------------------------------------------+ +| | COLSPAN=[pixels] | +| +---------------------------------------------------------------+ +| | ROWSPAN=[pixels] | +| +---------------------------------------------------------------+ +| | NOWRAP | ++------------------+---------------------------------------------------------------+ +| TH | ALIGN=[alignment] | +| +---------------------------------------------------------------+ +| | VALIGN=[v_alignment] | +| +---------------------------------------------------------------+ +| | BGCOLOR=[color] | +| +---------------------------------------------------------------+ +| | WIDTH=[percent|pixels] | +| +---------------------------------------------------------------+ +| | COLSPAN=[pixels] | +| +---------------------------------------------------------------+ +| | ROWSPAN=[pixels] | ++------------------+---------------------------------------------------------------+ +| TITLE | | ++------------------+---------------------------------------------------------------+ +| TR | ALIGN=[alignment] | +| +---------------------------------------------------------------+ +| | VALIGN=[v_alignment] | +| +---------------------------------------------------------------+ +| | BGCOLOR=[color] | ++------------------+---------------------------------------------------------------+ +| TT | | ++------------------+---------------------------------------------------------------+ +| U | | ++------------------+---------------------------------------------------------------+ +| UL | | ++------------------+---------------------------------------------------------------+ + + + +List of supported styles +~~~~~~~~~~~~~~~~~~~~~~~~~ + +:mod:`html` doesn't really have CSS support but it does support a few simple +styles: you can use ``"text-align"``, ``"width"``, ``"vertical-align"`` and +``"background"`` with all elements and for ``SPAN`` elements a few other +styles are additionally recognized: + +- ``color`` +- ``font-family`` +- ``font-size`` (only in point units) +- ``font-style`` (only "oblique", "italic" and "normal" values are supported) +- ``font-weight`` (only "bold" and "normal" values are supported) +- ``text-decoration`` (only "underline" value is supported) + diff --git a/docs/sphinx/rest_substitutions/overviews/index.rst b/docs/sphinx/rest_substitutions/overviews/index.rst index d09d067f..76438c9e 100644 --- a/docs/sphinx/rest_substitutions/overviews/index.rst +++ b/docs/sphinx/rest_substitutions/overviews/index.rst @@ -152,6 +152,7 @@ The new wxPython API documentation is available `in this page `_. filesystem_overview font_encodings font_overview + html_overview internationalization listctrl_overview log_classes_overview @@ -171,6 +172,8 @@ The new wxPython API documentation is available `in this page `_. window_styles_overview dataview.1classindex lib + py + tools Indices and tables diff --git a/docs/sphinx/rest_substitutions/overviews/internationalization.rst b/docs/sphinx/rest_substitutions/overviews/internationalization.rst index 23f7c51a..06659976 100644 --- a/docs/sphinx/rest_substitutions/overviews/internationalization.rst +++ b/docs/sphinx/rest_substitutions/overviews/internationalization.rst @@ -11,7 +11,7 @@ |phoenix_title| **Internationalization Overview** ================================================== -"Internationalization" (often referred to as I18N) is the process to change an +"Internationalization" (often referred to as i18n) is the process to change an application so that all user visible texts are translated to the user selected language and that things like dates, money amounts and numbers in general are shown in a format the user is familiar with/or used to. @@ -25,24 +25,27 @@ Text translation Prepare the source code ----------------------- -Text translation in Python is done using gettext [1]_ , to ensure that all wxPython -labels are also translated we will use :class:`Locale` and :func:`GetTranslation` . +Text translation in Python is done using gettext [1]_ , to ensure that all +wxPython labels are also translated we will use :class:`Locale` and +:func:`GetTranslation` . How to prepare your source code to enable translation of texts:: aString = _(u"This is a string which will be translated") -As you can see it is very simple, you just enclose the text with the translation function "_()", -obviously there is a bit more to it, see below. +As you can see it is very simple, you just enclose the text with the translation +function "_()", obviously there is a bit more to it, see below. -Enabling I18N for a whole application you would do some setup in the application file along the following lines: +Enabling I18N for a whole application you would do some setup in the application +file along the following lines: .. literalinclude:: _downloads/i18nwxapp/app_base.py :lines: 25-27 -Here we setup the "_" translation function and making it available application by adding it to builtin. +Here we setup the "_" translation function and making it available application +by adding it to builtin. The code required to change to a different language is as follows: @@ -53,39 +56,44 @@ The code required to change to a different language is as follows: Do the actual translation work ------------------------------ -You need to extract all the text strings marked by the "_" function, a little script `geni18n.py` is in the -:download:`downloadable zip file <_downloads/i18nwxapp/i18nwxapp.zip>`, it will extract all the strings -and generate a ``.pot`` file. The `geni18n.py` script will also generate the ``.mo`` files for defined languages. +You need to extract all the text strings marked by the "_" function, a little +script `geni18n.py` is in the :download:`downloadable zip file <_downloads/i18nwxapp/i18nwxapp.zip>`, +it will extract all the strings and generate a ``.pot`` file, which is put to +the locale folder. The `geni18n.py` script will also generate the ``.mo`` files +for defined languages. -The ``.pot`` file is then provided to the translators and they use it to generate a ``.po`` file for -the language they translate too or they can also use the ``.pot`` file to merge new/changed text strings -to an existing ``.po`` file. +The ``.pot`` file is then provided to the translators and they use it to +generate a ``.po`` file for the language they translate too or they can also use +the ``.pot`` file to merge new/changed text strings to an existing ``.po`` file. -To do the actual translation we recomment `poEdit` [2]_ , it allows you to create or update a translation -catalog (``.po`` file) from the ``.pot`` file. +To do the actual translation we recomment `poEdit` [2]_ , it allows you to +create or update a translation catalog (``.po`` file) from the ``.pot`` file. Sample application ------------------ -In the :download:`downloadable zip file <_downloads/i18nwxapp/i18nwxapp.zip>` we included a small -sample application showing the above in action. +In the :download:`downloadable zip file <_downloads/i18nwxapp/i18nwxapp.zip>` +we included a small sample application showing the above in action. - `app_base.py` contains the initialization code - `sampleapp.py` is the main frame/application, just run this to see things in action -- `i18ntools/geni18n.py` is the script to generate the ``.pot`` file and it also generates the ``.mo`` files. +- `geni18n.py` is the script to generate the ``.pot`` file and it also generates the ``.mo`` files. .. note:: - The application has a button which displays a file dialog, as wxPython uses a native widget for this the - text are shown in the operating system language and not the language which is selected in `app_base.py`. + The application has a button which displays a file dialog, as wxPython uses + a native widget for this the text are shown in the operating system language + and not the language which is selected in `app_base.py`. Localization overview ===================== -"Localization", often referred to as "L10N", is the process to adapt the display of dates and numbers to local custom. +"Localization", often referred to as "L10n", is the process to adapt the display +of dates and numbers to local custom. -E.g. "4/5/2012" would for an American mean April 5. 2012, but for most Europeans it would be 4. May 2012. +E.g. "4/5/2012" would for an American mean April 5. 2012, but for most Europeans +it would be 4. May 2012. Localize dates @@ -100,6 +108,14 @@ Localize numbers .. todo:: to be written +Additional resources +==================== + +- http://zetcode.com/wxpython/in18/ +- http://wiki.wxpython.org/Internationalization +- http://en.wikipedia.org/wiki/Internationalization_and_localization + + .. rubric:: Footnotes .. [1] gettext - http://docs.python.org/library/gettext.html diff --git a/docs/sphinx/rest_substitutions/snippets/python/converted/ContextHelp.1.py b/docs/sphinx/rest_substitutions/snippets/python/converted/ContextHelp.1.py new file mode 100644 index 00000000..208fca48 --- /dev/null +++ b/docs/sphinx/rest_substitutions/snippets/python/converted/ContextHelp.1.py @@ -0,0 +1,2 @@ + + contextHelp = wx.ContextHelp(myWindow) diff --git a/docs/sphinx/rest_substitutions/snippets/python/converted/HelpControllerBase.SetViewer.1.py b/docs/sphinx/rest_substitutions/snippets/python/converted/HelpControllerBase.SetViewer.1.py new file mode 100644 index 00000000..f99f56fa --- /dev/null +++ b/docs/sphinx/rest_substitutions/snippets/python/converted/HelpControllerBase.SetViewer.1.py @@ -0,0 +1,4 @@ + + self.help.SetViewer("kdehelp") + self.help.SetViewer("gnome-help-browser") + self.help.SetViewer("netscape", wx.HELP_NETSCAPE) diff --git a/etgtools/sphinx_generator.py b/etgtools/sphinx_generator.py index 79f6a591..13f8d453 100644 --- a/etgtools/sphinx_generator.py +++ b/etgtools/sphinx_generator.py @@ -1673,7 +1673,9 @@ class Emphasis(Node): tail = child.element.tail tail = (tail is not None and [tail] or [''])[0] - childText = childText.replace(ConvertToPython(tail), '') + if tail.strip() != ':': + childText = childText.replace(ConvertToPython(tail), '') + fullChildText = child.Join() endPos = text.index(childText) diff --git a/sphinxtools/constants.py b/sphinxtools/constants.py index 30ea011c..1ffecd22 100644 --- a/sphinxtools/constants.py +++ b/sphinxtools/constants.py @@ -209,3 +209,35 @@ MODULE_TO_ICON = [(".py", object_types.PY_MODULE, "Py_Module"), (".pyd", obje (".pyc", object_types.PYC_MODULE, "Pyc_Module"), (".pyw", object_types.PYW_MODULE, "Pyw_Module"), (".so", object_types.PYD_MODULE, "Pyd_Module")] +# wx.tools and other stuff + +DOXY_2_REST = [('@author:', '\n.. moduleauthor:: '), + ('@deprecated:', '\n.. deprecated:: '), + ('@param', ':param'), + ('@var', ':param'), + ('@keyword', ':keyword'), + ('@kwarg', ':keyword'), + ('@note:', '\n.. note:: '), + ('@package:', '\n**Package:** '), + ('@package', '\n**Package:** '), + ('@postcondition:', '\n:postcondition: '), + ('@pre:', '\n:precondition: '), + ('@precondition:', '\n:precondition: '), + ('@requires:', '\n:requires: '), + ('@returns:', '\n:returns: '), + ('@return:', '\n:returns: '), + ('@returns', '\n:returns: '), + ('@return', '\n:returns: '), + ('@rtype:', '\n:rtype: '), + # ('@section', XXX), Deal with this separately + ('@see:', '\n.. seealso:: '), + ('@status:', '\n.. todo:: '), + ('@summary:', '\n**Summary:** '), + ('@throws:', '\n:raise: '), + ('@todo:', '\n.. todo:: '), + ('@verbatim ', ''), # TODO This one + ('@verbatim', ''), # TODO This one + ('@endverbatim ', ''), # TODO This one + ('@endverbatim', ''), # TODO This one + ('@version:', '\n:version: ')] + diff --git a/sphinxtools/librarydescription.py b/sphinxtools/librarydescription.py index 5b3337fc..04d783ed 100644 --- a/sphinxtools/librarydescription.py +++ b/sphinxtools/librarydescription.py @@ -11,12 +11,14 @@ from inspect import getmro, getclasstree, getdoc, getcomments from utilities import MakeSummary, ChopDescription, WriteSphinxOutput from utilities import FindControlImages, PickleClassInfo -from constants import object_types, MODULE_TO_ICON +from constants import object_types, MODULE_TO_ICON, DOXY_2_REST import templates ENOENT = getattr(errno, 'ENOENT', 0) EPIPE = getattr(errno, 'EPIPE', 0) +EPYDOC_PATTERN = re.compile(r'\S+{\S+}', re.DOTALL) + reload(sys) sys.setdefaultencoding("utf-8") @@ -73,7 +75,7 @@ def generic_summary(libraryItem, stream): table = [] for item in sub_list: - if item.is_redundant or item.GetShortName().startswith('__test'): + if item.is_redundant or item.GetShortName().startswith('__test') or '.extern.' in item.name: continue docs = ChopDescription(ReplaceWxDot(item.docs)) @@ -106,9 +108,156 @@ def ReplaceWxDot(text): # Masked is funny... text = text.replace('', '') - return text + space_added = False + for old, new in DOXY_2_REST: + + if old not in text: + continue + + if new in [':keyword', ':param']: + if not space_added: + space_added = True + new_with_newline = '\n%s'%new + text = text.replace(old, new_with_newline, 1) + + text = text.replace(old, new) + lines = text.splitlines(True) + newtext = '' + + for line in lines: + if '@section' not in line: + newtext += line + continue + + # Extract the section header + splitted = line.split() + header = ' '.join(line[2:]) + header = header.strip() + + newtext += header + '\n' + newtext += '-'*len(header) + '\n\n' + + return newtext + + +def GetTopLevelParent(klass): + + parent = klass.parent + + if not parent: + return klass + + parents = [parent] + + while parent: + parent = parent.parent + parents.append(parent) + + return parents[-2] + + +def FindInHierarchy(klass, newlink): + + library = GetTopLevelParent(klass) + return library.FindItem(newlink) + + +def FindBestLink(klass, newlink): + + parent_class = klass.parent + + if klass.kind in range(object_types.FUNCTION, object_types.INSTANCE_METHOD): + if parent_class.GetShortName() == newlink: + return ':class:`%s`'%newlink + else: + child_names = [sub.GetShortName() for sub in parent_class.children] + if newlink in child_names: + index = child_names.index(newlink) + child = parent_class.children[index] + + if child.kind in range(object_types.PACKAGE, object_types.PYW_MODULE+1): + return ':mod:`~%s`'%child.name + elif child.kind in range(object_types.FUNCTION, object_types.INSTANCE_METHOD): + return ':meth:`~%s`'%child.name + else: + return ':class:`~%s`'%child.name + + full_loop = FindInHierarchy(klass, newlink) + + if full_loop: + return full_loop + + return ':ref:`%s`'%newlink + + +def KillEpydoc(klass, newtext): + + epydocs = re.findall(EPYDOC_PATTERN, newtext) + + if not epydocs: + return newtext + + newepydocs = epydocs[:] + + for item in epydocs: + if '#{' in item: + # this is for masked stuff + newepydocs.remove(item) + + if not newepydocs: + return newtext + + for regex in newepydocs: + + start = regex.index('{') + end = regex.index('}') + + if 'U{' in regex: + # Simple link, leave it as it is + newlink = regex[start+1:end] + + elif 'C{' in regex: + # It's an inclined text, but we can attach some + # class reference to it + newlink = regex[start+1:end] + + if 'wx.' in regex or 'wx' in regex: + newlink = newlink.replace('wx.', '') + newlink = newlink.replace('wx', '') + newlink = ':class:`%s`'%newlink.strip() + else: + newlink = '`%s`'%newlink + + elif 'I{' in regex: + # It's an inclined text + newlink = regex[start+1:end] + newlink = ' `%s` '%newlink + + elif 'L{' in regex: + # Some kind of link, but we can't figure it out + # very easily from here... just use :ref: + newlink = regex[start+1:end] + + if newlink.upper() == newlink: + # Use double backticks + newlink = '``%s``'%newlink + else: + # Try and reference it + bestlink = FindBestLink(klass, newlink) + if bestlink: + newlink = bestlink + + else: + # Something else, don't bother for the moment + continue + + newtext = newtext.replace(regex, newlink) + + return newtext + + class ParentBase(object): def __init__(self, name, kind): @@ -275,6 +424,42 @@ class Library(ParentBase): self.Walk(child) + def FindItem(self, newlink, obj=None): + + if obj is None: + obj = self + + # must have at least root folder + children = obj.GetChildren() + bestlink = '' + + if not children: + return bestlink + + # check each name + for child in children: + + if child.is_redundant: + continue + + parts = child.name.split('.') + dotname = '.'.join(parts[-2:]) + if child.name.endswith(newlink) and (child.GetShortName() == newlink or dotname == newlink): + if child.kind in range(object_types.PACKAGE, object_types.PYW_MODULE+1): + return ':mod:`~%s`'%child.name + elif child.kind in range(object_types.FUNCTION, object_types.INSTANCE_METHOD+1): + return ':meth:`~%s`'%child.name + else: + return ':class:`~%s`'%child.name + + bestlink = self.FindItem(newlink, child) + + if bestlink: + return bestlink + + return bestlink + + def GetPythonVersion(self): return self.python_version @@ -288,7 +473,10 @@ class Library(ParentBase): header = templates.TEMPLATE_DESCRIPTION%(self.base_name, self.base_name) stream.write(header) - stream.write(ReplaceWxDot(self.docs) + '\n\n') + newtext = ReplaceWxDot(self.docs) + stream.write(newtext + '\n\n') + + newtext = KillEpydoc(self, newtext) generic_summary(self, stream) WriteSphinxOutput(stream, self.sphinx_file) @@ -320,7 +508,7 @@ class Module(ParentBase): def ToRest(self): - if self.is_redundant or self.GetShortName().startswith('__test'): + if self.is_redundant or self.GetShortName().startswith('__test') or '.extern.' in self.name: return stream = StringIO() @@ -336,7 +524,11 @@ class Module(ParentBase): header = templates.TEMPLATE_DESCRIPTION%(self.name, '%s'%self.GetShortName()) stream.write(header) - stream.write(ReplaceWxDot(self.docs) + '\n\n') + + newtext = ReplaceWxDot(self.docs) + stream.write(newtext + '\n\n') + + newtext = KillEpydoc(self, newtext) spacer = ' '*self.name.count('.') @@ -443,7 +635,7 @@ class Class(ParentBase): def ToRest(self): - if self.is_redundant or self.GetShortName().startswith('__test'): + if self.is_redundant or self.GetShortName().startswith('__test') or '.extern.' in self.name: return stream = StringIO() @@ -455,6 +647,7 @@ class Class(ParentBase): stream.write('.. highlight:: python\n\n') class_docs = ReplaceWxDot(self.docs) + class_docs = KillEpydoc(self, class_docs) header = templates.TEMPLATE_DESCRIPTION%(self.name, self.GetShortName()) stream.write(header) @@ -536,8 +729,11 @@ class Class(ParentBase): index = self.signature.index(' def __init__') self.signature = self.signature[0:index] - self.signature.strip() - + self.signature = self.signature.strip() + + if len(self.signature) < 2: + self.is_redundant = True + class ChildrenBase(object): @@ -641,6 +837,9 @@ class Method(ChildrenBase): if ' def ' in self.signature: index = self.signature.index(' def ') self.signature = self.signature[index+5:].strip() + + if '*' in self.signature: + self.signature = self.signature.replace('*', r'\*') if not self.signature.strip(): self.is_redundant = True @@ -668,12 +867,14 @@ class Method(ChildrenBase): return text = '' - for line in self.docs.splitlines(): - text += indent + ReplaceWxDot(line) + '\n' - - text += '\n\n' - stream.write(text) + newdocs = ReplaceWxDot(self.docs) + for line in newdocs.splitlines(True): + text += indent + line + + text = KillEpydoc(self, text) + text += '\n\n\n' + stream.write(text) class Property(ChildrenBase): diff --git a/sphinxtools/modulehunter.py b/sphinxtools/modulehunter.py index d8035a53..bbaf01e7 100644 --- a/sphinxtools/modulehunter.py +++ b/sphinxtools/modulehunter.py @@ -504,12 +504,12 @@ def FindModuleType(filename): def SubImport(import_string, module, parent_class, ispkg): - + try: submod = __import__(import_string, fromlist=[module]) except: # pubsub and Editra can be funny sometimes... - message = "Unable to import module/package '%s'.\n Exception was: %s"%(module, format_traceback()) + message = "Unable to import module/package '%s.%s'.\n Exception was: %s"%(import_string, module, format_traceback()) print "\nWARNING: %s\n"%message return None, 0 @@ -517,6 +517,10 @@ def SubImport(import_string, module, parent_class, ispkg): return None, 0 filename = getfile(submod) + + subpath = os.path.dirname(filename) + if subpath not in sys.path: + sys.path.append(subpath) if ispkg: kind = object_types.PACKAGE @@ -545,7 +549,7 @@ def SubImport(import_string, module, parent_class, ispkg): def ModuleHunter(init_name, import_name, version): - pickle_file = os.path.join(os.getcwd(), 'docs', 'sphinx', 'wxlib.pkl') + pickle_file = os.path.join(os.getcwd(), 'docs', 'sphinx', 'wx%s.pkl'%import_name) if os.path.isfile(pickle_file): fid = open(pickle_file, 'rb')