Phoenix Logo

Welcome to wxPython (Phoenix)'s documentation!

SVN Revisions

“Built with wxWidgets & wxPython SVN revision r71577M

Welcome! This is the documentation for wxPython (Phoenix), last updated 29 May 2012.

This is the first, very-alpha release of this set of documentation. Documentation TODOs:

  • Add the pure-Python classes, methods and functions (i.e., wx.CallAfter)
  • Find a way to link snippets of code to (almost) every class (maybe from the demo?)
  • Link the documentation to the wxPython Wiki (a web crawler will be needed)
  • Add wx.lib and the various other pure-Python third party libraries

Phoenix is the code name of for the new version of wxPython. Robin Dunn called this the Phoenix project because in the process of doing this project wxPython's implementation will be utterly destroyed and then reborn in a new and marvelous way, much like the mythical Phoenix rising from the ashes of its former self.

For wxPython many things about how the wrapper/bindings code is produced will be changing, and we'll also be eliminating some other crud along the way.

Some interesting documents about the current status or the Phoenix project and its development:

  • Migration Guide: the Migration Guide will give you some hints on how to modify your existing wxPython applications to be compatible with Phoenix
  • TODO List: maily for developers, this document explains what remains to be done in order to complete the Phoenix project
  • Project Goals: this external link highlights the project goals and the driving forces behind it
  • Development Process: this external link shows the main thoughts behind the project Phoenix implementation


If you wish to help in the documentation effort, the main docstrings guidelines are outlined in this document.

The Phoenix documentation has been built automatically starting from XML files representing the wxWidgets C++ documentation (generated using Doxygen).

I developed a set of Python routines to translate this XML hell into reStructuredText. Then, Sphinx has been used to generate the final set of documentation for Phoenix.