Merge remote-tracking branch 'refs/remotes/wxWidgets/master' into classic_vs_phoenix_metafile_update

TODO.rst

@@ -82,25 +82,33 @@ check if the the feature is available in wxWidgets or if the stubs should be
 compiled.)
 
 
-Reorganize Sphinx output
-------------------------
+Sphinx tweaks
+-------------
 
-To make it easier for 3rd party tools to find the docs for specific
-classes and methods it would be good to change how the file names for
-the class pages are generated.  Currently it looks like just the
-leading "wx." is missing from the file names.  So that means that
-classes in "core" do not have any package prefix in the filename at
-all.  For example, .../html/Bitmap.html instead of
-.../html/wx.Bitmap.html.  The same holds true for classes in the other
-extension modules in wx, and also wx.lib.
+The big changes are done, but here are some dangling strings that still need
+to be untangled:
 
-    .../html/adv.AnimationCtrl.html
-    .../html/lib.buttons.GenButton.html	
-    etc.
+  * The `chopDescription()` function is not very smart. See if it can be made a
+    little smarter and pull out the first sentence from the docstring instead
+    of ust the first line.
 
-The intra-document anchor links should also have the leading "wx."
-added to them for consistency.
+  * Convert the main.html page to a ReST file? It would probably make it a
+    little easier to maintain.
 
+  * Turn off full justification of text?
+
+  * Set max width of body sections?  I think it looks a little nicer that way,
+    but we'll need to fix the floating and alignment of the sidebar to do
+    it...
+
+  * Change the column widths of the ReST simple tables, to be about 30/70 instead
+    of 50/50.  This can be done by changing how many '=' are generated for the top
+    and bottom lines of the tables.
+
+  * Move the building of the docs to the Windows build slave so the Windows
+    specific modules will be present for the wxlib build command, so those
+    modules can be documented.
+    
 
 
 Other Dev Stuff
@@ -174,10 +182,10 @@ Other Dev Stuff
     bytes objects, they should probably be string objects. Or not, sip's
     default might be best... See ModuleDef.addGlobalStr if I change my mind.
 
-  * If a function or method has overloads but all but one all ignored then the doc
-    generator should not use the "*args, **kw" form of output and just use the
-    args string of the remaining function or method definition like for those
-    that do not have overloads.  For example, see Window.GetClientSize
+  * If a function or method has overloads but all but one all ignored then the
+    doc generator should not use the "\*args, \*\*kw" form of output and just use
+    the args string of the remaining function or method definition like for
+    those that do not have overloads.  For example, see Window.GetClientSize
 
   * Check gui_scripts entry points.
 

b

@@ -5,11 +5,11 @@
 if [ "$OSTYPE" = "cygwin" ]; then
     PYTHON=`which python.exe`
     echo $PYTHON
-    $PYTHON -u build.py "$@"
+    $PYTHON -u build.py --dev "$@"
 else
     PYTHON=`which python`
     echo $PYTHON
-    $PYTHON -u build.py "$@"
+    $PYTHON -u build.py --dev "$@"
 fi
 
 exit $?

bin/build-sip-posix

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 set -o errexit
-#set -o xtrace 
+#set -o xtrace
 
 PYVER=2.7
 PYTHON=`which python$PYVER`
@@ -13,29 +13,34 @@ fi
 
 MYBINDIR=$(dirname $(readlink -f $0))
 
-cd $PROJECTS/sip/sip
-SIPVER=`$PYTHON configure.py --version | grep -v "This is SIP"`
 PLATFORM=`$PYTHON -c "import buildtools.config as bc; print(bc.getToolsPlatformName(True))"`
 echo $PLATFORM
+cd $PROJECTS/sip/sip
+SIPVER=`$PYTHON configure.py --version | grep -v "This is SIP"`
 
 if [ "$PLATFORM" = "darwin" ]; then
-    # try to ensure compatiblity back to 10.5 if we can
+    # try to ensure compatibility back to 10.6 if we can
     xcode=$(xcode-select -print-path)
-    if [ -d $xcode/SDKs/MacOSX10.5.sdk ]; then
-        SDK=$xcode/SDKs/MacOSX10.5.sdk
-    elif [ -d $xcode/SDKs/MacOSX10.6.sdk ]; then
-        SDK=$xcode/SDKs/MacOSX10.6.sdk
-    elif [ -d $xcode/SDKs/MacOSX10.7.sdk ]; then
-        SDK=$xcode/SDKs/MacOSX10.7.sdk
-    fi
+    for v in 6 7 8 9 10 11 12; do
+        if [ -d $xcode/SDKs/MacOSX10.$v.sdk ]; then
+            SDK=$xcode/SDKs/MacOSX10.$v.sdk
+            break
+        elif [ -d $xcode/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.$v.sdk ]; then
+            SDK=$xcode/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.$v.sdk
+            break
+        fi
+    done
+
     $PYTHON configure.py \
-	--deployment-target=10.5 \
+	--deployment-target=10.6 \
 	--sdk=$SDK \
 	--arch=i386 \
+	--universal \
 	--sip-module wx.siplib \
 	$*
 
     make -C sipgen clean all
+
 else
     $PYTHON configure.py \
 	--sip-module wx.siplib \

bin/make-new-etg-file.py

@@ -56,7 +56,9 @@ def run():
     #-----------------------------------------------------------------
     # Tweak the parsed meta objects in the module object as needed for
     # customizing the generated code and docstrings.
-    
+
+    #module.addHeaderCode('#include <wx/some_header_file.h>')
+
     #c = module.find('')
     #assert isinstance(c, etgtools.ClassDef)
     

build.py

@@ -72,12 +72,12 @@ wxICON = 'docs/sphinx/_static/images/sphinxdocs/mondrian.png'
 
 # Some tools will be downloaded for the builds. These are the versions and
 # MD5s of the tool binaries currently in use.
-sipCurrentVersion = '4.16.7'
+sipCurrentVersion = '4.18.1.dev1606100655'
 sipMD5 = {
-    'darwin'   : '29874bb82327e556554e3ca8ddf8fa16',
-    'win32'    : 'd19030b397034742694a6d229f056ad0', 
-    'linux32'  : '6f70956abd8f837b1d55dc5cfa9f6201', 
-    'linux64'  : '6ac7653c331462516abbc38c5b93e0ac', 
+    'darwin'   : '48f7370706c63036fac66da6439559e8',
+    'win32'    : '138b2daa19a357ac9d92edd9a8e149b9',
+    'linux32'  : '23f00942b1eb5d69a7bdac517c4e2995',
+    'linux64'  : 'fce6937c3e67c2d099a8610890d81f87',
 }
 
 wafCurrentVersion = '1.7.15-p1'
@@ -863,7 +863,7 @@ def cmd_etg(options, args):
 
     
 def cmd_sphinx(options, args):
-    from sphinxtools.postprocess import SphinxIndexes, MakeHeadings, PostProcess, GenGallery
+    from sphinxtools.postprocess import genIndexes, makeHeadings, postProcess, genGallery
 
     cmdTimer = CommandTimer('sphinx')
     pwd = pushDir(phoenixDir())
@@ -885,8 +885,8 @@ def cmd_sphinx(options, args):
         txt = os.path.join(sphinxDir, os.path.splitext(rstName)[0] + '.txt')
         copyIfNewer(rst, txt)
 
-    SphinxIndexes(sphinxDir)
-    GenGallery()
+    genIndexes(sphinxDir)
+    genGallery()
 
     # Copy the hand-edited top level doc files too
     rstFiles = [os.path.join(phoenixDir(), 'TODO.rst')] + \
@@ -895,7 +895,7 @@ def cmd_sphinx(options, args):
         txt = os.path.join(sphinxDir, os.path.splitext(os.path.basename(rst))[0] + '.txt')
         copyIfNewer(rst, txt)
     
-    MakeHeadings()
+    makeHeadings()
 
     pwd2 = pushDir(sphinxDir)
     buildDir = os.path.join(sphinxDir, 'build')
@@ -904,7 +904,7 @@ def cmd_sphinx(options, args):
     del pwd2
     
     msg('Postprocessing sphinx output...')
-    PostProcess(htmlDir)
+    postProcess(htmlDir)
 
 
 def cmd_wxlib(options, args):
@@ -913,52 +913,25 @@ def cmd_wxlib(options, args):
     cmdTimer = CommandTimer('wx.lib')
     pwd = pushDir(phoenixDir())
 
-    libDir = os.path.join(phoenixDir(), 'wx', 'lib')
+    for wx_pkg in ['lib', 'py', 'tools']:
+        libDir = os.path.join(phoenixDir(), 'wx', wx_pkg)
 
-    if not os.path.isdir(libDir):
-        raise Exception('Missing wx.lib folder in the distribution')
+        if not os.path.isdir(libDir):
+            raise Exception('Missing wx.{} folder in the distribution'.format(wx_pkg))
+
+        init_name = os.path.join(libDir, '__init__.py')
+        import_name = 'wx.{}'.format(wx_pkg)
+
+        ModuleHunter(init_name, import_name, version3)
 
-    init_name = os.path.join(libDir, '__init__.py')
-    import_name = 'lib'
-    version = version3
 
-    ModuleHunter(init_name, import_name, version)
-    
 
 def cmd_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)
+    msg('Command wxpy has been folded into command wxlib.')
 
 
 def cmd_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)
+    msg('Command wxtools has been folded into command wxlib.')
 
 
 def cmd_docs_bdist(options, args):
@@ -1484,7 +1457,7 @@ def cmd_clean_py(options, args):
     cfg = Config()
     deleteIfExists(getWafBuildBase())
     files = list()
-    for wc in ['*.py', '*.pyc', '*.so', '*.dylib', '*.pyd', '*.pdb', '*.pi']:
+    for wc in ['*.py', '*.pyc', '*.so', '*.dylib', '*.pyd', '*.pdb', '*.pi', '*.pyi']:
         files += glob.glob(opj(cfg.PKGDIR, wc))
     if isWindows:
         msw = getMSWSettings(options)
@@ -1499,7 +1472,6 @@ def cmd_clean_py(options, args):
         cmd_clean_py(options, args)
         options.both = True
 
-
     
 def cmd_clean_sphinx(options, args):
     cmdTimer = CommandTimer('clean_sphinx')
@@ -1508,6 +1480,7 @@ def cmd_clean_sphinx(options, args):
     sphinxDir = opj(phoenixDir(), 'docs', 'sphinx')
          
     globs = [ opj(sphinxDir, '*.txt'),
+              opj(sphinxDir, '*.rst'),
               opj(sphinxDir, '*.inc'),
               opj(sphinxDir, '*.pkl'),
               opj(sphinxDir, '*.lst'),

buildbot/master.cfg

@@ -222,7 +222,7 @@ def makeFactory(port, buildType='buildOnly', pyVer='2.7'):
                         mode=mode, method=method))
 
     if buildType == 'docs':
-        cmd = 'python -u build.py %s setrev dox touch etg sip build wxlib wxtools wxpy ' \
+        cmd = 'python -u build.py %s setrev dox touch etg sip build wxlib ' \
               'sphinx docs_bdist sdist --upload' % pyVer
     else:
         cmd = 'python -u build.py %s %s setrev dox touch etg --nodoc sip build' % (pyVer, clean)

buildtools/build_wxwidgets.py

@@ -285,7 +285,8 @@ def main(wxDir, args):
                             ]
 
         if sys.platform.startswith("darwin"):
-            wxpy_configure_opts.append("--enable-monolithic")
+            #wxpy_configure_opts.append("--enable-monolithic")
+            pass
         else:
             wxpy_configure_opts.append("--with-sdl")
 

demo/ColourDB.py

@@ -110,12 +110,12 @@ class TestWindow(wx.ScrolledWindow):
             rect = rgn.GetBox()
             pixStart = vs[1]*self.lineHeight + rect.y
             pixStop  = pixStart + rect.height
-            start = pixStart / self.lineHeight - 1
-            stop = pixStop / self.lineHeight
+            start = pixStart // self.lineHeight - 1
+            stop = pixStop // self.lineHeight
         else:
             start = 0
             stop = numColours
-
+            
         for line in range(max(0,start), min(stop,numColours)):
             clr = colours[line][0]
             y = (line+1) * self.lineHeight + 2

demo/DrawXXXList.py

@@ -106,7 +106,7 @@ def makeRandomPens(num, cache):
         c = random.choice(colours)
         t = random.randint(1, 4)
 
-        if not cache.has_key( (c, t) ):
+        if not (c, t) in cache.keys():
             cache[(c, t)] = wx.Pen(c, t)
 
         pens.append( cache[(c, t)] )
@@ -120,7 +120,7 @@ def makeRandomBrushes(num, cache):
     for i in range(num):
         c = random.choice(colours)
 
-        if not cache.has_key(c):
+        if not c in cache.keys():
             cache[c] = wx.Brush(c)
 
         brushes.append( cache[c] )

demo/GridBagSizer.py

@@ -95,18 +95,19 @@ class TestFrame(wx.Frame):
             self.gbs.SetItemPosition(btn, self.lastPos)
             btn.SetLabel("Move this to (3,6)")
         else:
-            if self.gbs.CheckForIntersectionPos( (3,6), (1,1) ):
+            if self.gbs.CheckForIntersection( (3,6), (1,1) ):
                 wx.MessageBox("""\
-wx.GridBagSizer will not allow items to be in the same cell as
-another item, so this operation will fail.  You will also get an
-assert when compiled in debug mode.""",
+wx.GridBagSizer will not allow items to be in the
+same cell as another item, so this operation will
+fail.  You will also get an assert when compiled
+in debug mode.""",
                               "Warning", wx.OK | wx.ICON_INFORMATION)
 
             try:
                 if self.gbs.SetItemPosition(btn, (3,6)):
                     self.lastPos = curPos
                     btn.SetLabel("Move it back")
-            except wx.PyAssertionError:
+            except wx.wxAssertionError:
                 pass
 
         self.gbs.Layout()
@@ -116,9 +117,9 @@ assert when compiled in debug mode.""",
         pt = evt.GetPosition()
         item = self.gbs.FindItemAtPoint(pt)
         if item is None:
-            print("no item at", `pt`)
+            print("no item at", repr(pt))
         else:
-            print("item found: ", `item.GetPos()`, "--", `item.GetSpan()`)
+            print("item found: ", repr(item.GetPos()), "--", repr(item.GetSpan()))
 
 
 #---------------------------------------------------------------------------

demo/MediaCtrl.py

@@ -26,13 +26,9 @@ class TestPanel(wx.Panel):
 
         # Create some controls
         try:
-            backend = ""
-            if 'wxMSW' in wx.PlatformInfo:
-                # the default backend doesn't always send the EVT_MEDIA_LOADED
-                # event which we depend upon, so use a different backend by
-                # default for this demo.
-                backend = wx.media.MEDIABACKEND_QUICKTIME
-                
+            backend = "" # let MediaCtrl choose default backend
+            #backend=wx.media.MEDIABACKEND_DIRECTSHOW
+            #backend=wx.media.MEDIABACKEND_WMP10
             self.mc = wx.media.MediaCtrl()
             ok = self.mc.Create(self, style=wx.SIMPLE_BORDER,
                                 szBackend=backend)
@@ -42,6 +38,9 @@ class TestPanel(wx.Panel):
             self.Destroy()
             raise
 
+        # the following event is not sent with the Windows default backend
+        # MEDIABACKEND_DIRECTSHOW
+        # choose above e.g. MEDIABACKEND_WMP10 if this is a problem for you
         self.Bind(wx.media.EVT_MEDIA_LOADED, self.OnMediaLoaded)
 
         btn1 = wx.Button(self, -1, "Load File")
@@ -100,15 +99,17 @@ class TestPanel(wx.Panel):
 
 
     def DoLoadFile(self, path):
-        self.playBtn.Disable()
+        
         if not self.mc.Load(path):
             wx.MessageBox("Unable to load %s: Unsupported format?" % path,
                           "ERROR",
                           wx.ICON_ERROR | wx.OK)
+            self.playBtn.Disable()
         else:
             self.mc.SetInitialSize()
             self.GetSizer().Layout()
             self.slider.SetRange(0, self.mc.Length())
+            self.playBtn.Enable()
 
     def OnMediaLoaded(self, evt):
         self.playBtn.Enable()

docs/sphinx/_static/css/basic.css

@@ -123,7 +123,7 @@ table.contentstable p.biglink {
 }
 
 a.biglink {
-    font-size: 1.3em;
+    font-size: 1.2em;
 }
 
 span.linkdescr {

docs/sphinx/_static/css/phoenix.css

@@ -88,7 +88,8 @@ div.body h4 {
  */
 
 body { 
-  background-color: rgb(230,230,230);
+    background-color: rgb(230,230,230);
+    font-size: 0.95em;
 }
 
 div.headerimage {
@@ -104,7 +105,7 @@ div.document {
   position: relative;
   margin-left: 240px;
   z-index: 0;
-  top: 50px;
+  top: 30px;
 }
 
 div.sphinxsidebar {
@@ -118,15 +119,26 @@ div.sphinxsidebar {
     height: auto;
     z-index: 1;
     left: 0;
-    top: 50px;
-    bottom: 0;  
+    top: 30px;
+    bottom: 0;    
+}
+
+div#searchbox {
+    margin-top: 30px;
+}
+
+div#sourcelink {
+    position: absolute; 
+    bottom: 0;
+    font-style: italic;
+    font-size: small;
 }
 
 div.related {
     background-image: url('../images/sphinxdocs/navigation.png');
     border-top: 1px solid #ddd;
     border-bottom: 1px solid #ddd;
-    font-size: 1em;
+    font-size: 90%;
     position: fixed;
     line-height: normal;
     position: fixed;
@@ -160,19 +172,21 @@ div.related ul li.right {
     font-size: small;
     float: right;
     margin-right: 5px;
-    margin-top: 0;
 }
 
 div.related ul li#searchbox.right {
     float: right;
     margin-right: 5px;
     margin-top:  7px;
+    font-size: 90%;
 }
+
 div.related ul li a {
     margin: 0;
     padding: 0 5px 0 5px;
     line-height: normal;
     color: #EE9816;
+    font-size: 90%;
 }
 
 div.related ul li.reltitle {
@@ -203,6 +217,18 @@ div.sphinxsidebar a {
   color: #355f7c;
 }
 
+div.section a {
+    color:  #ca7900;
+    font-weight: bold;
+    font-style: normal;
+    font-size: 0.95em;
+    letter-spacing: 0.01em;
+}
+
+div.section a:hover {
+    color: #2491cf;
+}
+
 div.sphinxsidebar ul.want-points {
   list-style: disc;
 }