Merging upstream work, and fixing installation docs.

The install docs have been fully updated and now reflect the current
code state.

IPython/frontend/wx/console_widget.py

@@ -1,436 +1,436 b''
 # encoding: utf-8
 """
 A Wx widget to act as a console and input commands.
 
 This widget deals with prompts and provides an edit buffer
 restricted to after the last prompt.
 """
 
 __docformat__ = "restructuredtext en"
 
 #-------------------------------------------------------------------------------
 #  Copyright (C) 2008  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is
 #  in the file COPYING, distributed as part of this software.
 #-------------------------------------------------------------------------------
 
 #-------------------------------------------------------------------------------
 # Imports
 #-------------------------------------------------------------------------------
 
 import wx
 import wx.stc  as  stc
 
 from wx.py import editwindow
 import time
 import sys
 LINESEP = '\n'
 if sys.platform == 'win32':
     LINESEP = '\n\r'
 
 import re
 
 # FIXME: Need to provide an API for non user-generated display on the
 # screen: this should not be editable by the user.
 
 _DEFAULT_SIZE = 10
 if sys.platform == 'darwin':
-    _DEFAULT_STYLE = 12
+    _DEFAULT_SIZE = 12
 
 _DEFAULT_STYLE = {
     'stdout'      : 'fore:#0000FF',
     'stderr'      : 'fore:#007f00',
     'trace'       : 'fore:#FF0000',
 
     'default'     : 'size:%d' % _DEFAULT_SIZE,
     'bracegood'   : 'fore:#00AA00,back:#000000,bold',
     'bracebad'    : 'fore:#FF0000,back:#000000,bold',
 
     # properties for the various Python lexer styles
     'comment'       : 'fore:#007F00',
     'number'        : 'fore:#007F7F',
     'string'        : 'fore:#7F007F,italic',
     'char'          : 'fore:#7F007F,italic',
     'keyword'       : 'fore:#00007F,bold',
     'triple'        : 'fore:#7F0000',
     'tripledouble'  : 'fore:#7F0000',
     'class'         : 'fore:#0000FF,bold,underline',
     'def'           : 'fore:#007F7F,bold',
     'operator'      : 'bold'
     }
 
 # new style numbers
 _STDOUT_STYLE = 15
 _STDERR_STYLE = 16
 _TRACE_STYLE  = 17
 
 
 # system colors
 #SYS_COLOUR_BACKGROUND = wx.SystemSettings.GetColour(wx.SYS_COLOUR_BACKGROUND)
 
 #-------------------------------------------------------------------------------
 # The console widget class
 #-------------------------------------------------------------------------------
 class ConsoleWidget(editwindow.EditWindow):
     """ Specialized styled text control view for console-like workflow.
 
         This widget is mainly interested in dealing with the prompt and
         keeping the cursor inside the editing line.
     """
 
     # This is where the title captured from the ANSI escape sequences are
     # stored.
     title = 'Console'
 
     # The buffer being edited.
     def _set_input_buffer(self, string):
         self.SetSelection(self.current_prompt_pos, self.GetLength())
         self.ReplaceSelection(string)
         self.GotoPos(self.GetLength())
 
     def _get_input_buffer(self):
         """ Returns the text in current edit buffer.
         """
         input_buffer = self.GetTextRange(self.current_prompt_pos,
                                                 self.GetLength())
         input_buffer = input_buffer.replace(LINESEP, '\n')
         return input_buffer
 
     input_buffer = property(_get_input_buffer, _set_input_buffer)
 
     style = _DEFAULT_STYLE.copy()
 
     # Translation table from ANSI escape sequences to color. Override
     # this to specify your colors.
     ANSI_STYLES = {'0;30': [0, 'BLACK'],            '0;31': [1, 'RED'],
                    '0;32': [2, 'GREEN'],            '0;33': [3, 'BROWN'],
                    '0;34': [4, 'BLUE'],             '0;35': [5, 'PURPLE'],
                    '0;36': [6, 'CYAN'],             '0;37': [7, 'LIGHT GREY'],
                    '1;30': [8, 'DARK GREY'],        '1;31': [9, 'RED'],
                    '1;32': [10, 'SEA GREEN'],       '1;33': [11, 'YELLOW'],
                    '1;34': [12, 'LIGHT BLUE'],      '1;35':
                                                      [13, 'MEDIUM VIOLET RED'],
                    '1;36': [14, 'LIGHT STEEL BLUE'], '1;37': [15, 'YELLOW']}
 
     # The color of the carret (call _apply_style() after setting)
     carret_color = 'BLACK'
     
     # Store the last time a refresh was done
     _last_refresh_time = 0
 
     #--------------------------------------------------------------------------
     # Public API
     #--------------------------------------------------------------------------
     
     def __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, 
                         size=wx.DefaultSize, style=wx.WANTS_CHARS, ):
         editwindow.EditWindow.__init__(self, parent, id, pos, size, style)
         self._configure_scintilla()
 
         self.Bind(wx.EVT_KEY_DOWN, self._on_key_down)
         self.Bind(wx.EVT_KEY_UP, self._on_key_up)
     
 
     def write(self, text, refresh=True):
         """ Write given text to buffer, while translating the ansi escape
             sequences.
         """
         # XXX: do not put print statements to sys.stdout/sys.stderr in 
         # this method, the print statements will call this method, as 
         # you will end up with an infinit loop
         title = self.title_pat.split(text)
         if len(title)>1:
             self.title = title[-2]
 
         text = self.title_pat.sub('', text)
         segments = self.color_pat.split(text)
         segment = segments.pop(0)
         self.GotoPos(self.GetLength())
         self.StartStyling(self.GetLength(), 0xFF)
         try:
             self.AppendText(segment)
         except UnicodeDecodeError:
             # XXX: Do I really want to skip the exception?
             pass
         
         if segments:
             for ansi_tag, text in zip(segments[::2], segments[1::2]):
                 self.StartStyling(self.GetLength(), 0xFF)
                 try:
                     self.AppendText(text)
                 except UnicodeDecodeError:
                     # XXX: Do I really want to skip the exception?
                     pass
 
                 if ansi_tag not in self.ANSI_STYLES:
                     style = 0
                 else:
                     style = self.ANSI_STYLES[ansi_tag][0]
 
                 self.SetStyling(len(text), style) 
                 
         self.GotoPos(self.GetLength())
         if refresh:
             current_time = time.time()
             if current_time - self._last_refresh_time > 0.03:
                 if sys.platform == 'win32':
                     wx.SafeYield()
                 else:
                     wx.Yield()
                 #    self.ProcessEvent(wx.PaintEvent())
                 self._last_refresh_time = current_time 
 
    
     def new_prompt(self, prompt):
         """ Prints a prompt at start of line, and move the start of the
             current block there.
 
             The prompt can be given with ascii escape sequences.
         """
         self.write(prompt, refresh=False)
         # now we update our cursor giving end of prompt
         self.current_prompt_pos = self.GetLength()
         self.current_prompt_line = self.GetCurrentLine()
         self.EnsureCaretVisible()
 
 
     def scroll_to_bottom(self):
         maxrange = self.GetScrollRange(wx.VERTICAL)
         self.ScrollLines(maxrange)
 
 
     def pop_completion(self, possibilities, offset=0):
         """ Pops up an autocompletion menu. Offset is the offset
             in characters of the position at which the menu should
             appear, relativ to the cursor.
         """
         self.AutoCompSetIgnoreCase(False)
         self.AutoCompSetAutoHide(False)
         self.AutoCompSetMaxHeight(len(possibilities))
         self.AutoCompShow(offset, " ".join(possibilities))
 
 
     def get_line_width(self):
         """ Return the width of the line in characters.
         """
         return self.GetSize()[0]/self.GetCharWidth()
 
     #--------------------------------------------------------------------------
     # EditWindow API
     #--------------------------------------------------------------------------
 
     def OnUpdateUI(self, event):
         """ Override the OnUpdateUI of the EditWindow class, to prevent 
             syntax highlighting both for faster redraw, and for more
             consistent look and feel.
         """
 
     #--------------------------------------------------------------------------
     # Private API
     #--------------------------------------------------------------------------
     
     def _apply_style(self):
         """ Applies the colors for the different text elements and the
             carret.
         """
         self.SetCaretForeground(self.carret_color)
 
         #self.StyleClearAll()
         self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT,  
                           "fore:#FF0000,back:#0000FF,bold")
         self.StyleSetSpec(stc.STC_STYLE_BRACEBAD,
                           "fore:#000000,back:#FF0000,bold")
 
         for style in self.ANSI_STYLES.values():
             self.StyleSetSpec(style[0], "bold,fore:%s" % style[1])
 
    
     def _configure_scintilla(self):
         self.SetEOLMode(stc.STC_EOL_LF)
 
         # Ctrl"+" or Ctrl "-" can be used to zoomin/zoomout the text inside 
         # the widget
         self.CmdKeyAssign(ord('+'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN)
         self.CmdKeyAssign(ord('-'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT)
         # Also allow Ctrl Shift "=" for poor non US keyboard users. 
         self.CmdKeyAssign(ord('='), stc.STC_SCMOD_CTRL|stc.STC_SCMOD_SHIFT, 
                                             stc.STC_CMD_ZOOMIN)
         
         # Keys: we need to clear some of the keys the that don't play
         # well with a console.
         self.CmdKeyClear(ord('D'), stc.STC_SCMOD_CTRL)
         self.CmdKeyClear(ord('L'), stc.STC_SCMOD_CTRL)
         self.CmdKeyClear(ord('T'), stc.STC_SCMOD_CTRL)
         self.CmdKeyClear(ord('A'), stc.STC_SCMOD_CTRL)
 
         self.SetEOLMode(stc.STC_EOL_CRLF)
         self.SetWrapMode(stc.STC_WRAP_CHAR)
         self.SetWrapMode(stc.STC_WRAP_WORD)
         self.SetBufferedDraw(True)
         self.SetUseAntiAliasing(True)
         self.SetLayoutCache(stc.STC_CACHE_PAGE)
         self.SetUndoCollection(False)
         self.SetUseTabs(True)
         self.SetIndent(4)
         self.SetTabWidth(4)
 
         # we don't want scintilla's autocompletion to choose 
         # automaticaly out of a single choice list, as we pop it up
         # automaticaly
         self.AutoCompSetChooseSingle(False)
         self.AutoCompSetMaxHeight(10)
         # XXX: this doesn't seem to have an effect.
         self.AutoCompSetFillUps('\n')
 
         self.SetMargins(3, 3) #text is moved away from border with 3px
         # Suppressing Scintilla margins
         self.SetMarginWidth(0, 0)
         self.SetMarginWidth(1, 0)
         self.SetMarginWidth(2, 0)
 
         self._apply_style()
 
         # Xterm escape sequences
         self.color_pat = re.compile('\x01?\x1b\[(.*?)m\x02?')
         self.title_pat = re.compile('\x1b]0;(.*?)\x07')
 
         #self.SetEdgeMode(stc.STC_EDGE_LINE)
         #self.SetEdgeColumn(80)
 
         # styles
         p = self.style
         self.StyleSetSpec(stc.STC_STYLE_DEFAULT, p['default'])
         self.StyleClearAll()
         self.StyleSetSpec(_STDOUT_STYLE, p['stdout'])
         self.StyleSetSpec(_STDERR_STYLE, p['stderr'])
         self.StyleSetSpec(_TRACE_STYLE, p['trace'])
 
         self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT, p['bracegood'])
         self.StyleSetSpec(stc.STC_STYLE_BRACEBAD, p['bracebad'])
         self.StyleSetSpec(stc.STC_P_COMMENTLINE, p['comment'])
         self.StyleSetSpec(stc.STC_P_NUMBER, p['number'])
         self.StyleSetSpec(stc.STC_P_STRING, p['string'])
         self.StyleSetSpec(stc.STC_P_CHARACTER, p['char'])
         self.StyleSetSpec(stc.STC_P_WORD, p['keyword'])
         self.StyleSetSpec(stc.STC_P_WORD2, p['keyword'])
         self.StyleSetSpec(stc.STC_P_TRIPLE, p['triple'])
         self.StyleSetSpec(stc.STC_P_TRIPLEDOUBLE, p['tripledouble'])
         self.StyleSetSpec(stc.STC_P_CLASSNAME, p['class'])
         self.StyleSetSpec(stc.STC_P_DEFNAME, p['def'])
         self.StyleSetSpec(stc.STC_P_OPERATOR, p['operator'])
         self.StyleSetSpec(stc.STC_P_COMMENTBLOCK, p['comment'])
 
     def _on_key_down(self, event, skip=True):
         """ Key press callback used for correcting behavior for 
             console-like interfaces: the cursor is constraint to be after
             the last prompt.
 
             Return True if event as been catched.
         """
         catched = True
         # Intercept some specific keys.
         if event.KeyCode == ord('L') and event.ControlDown() :
             self.scroll_to_bottom()
         elif event.KeyCode == ord('K') and event.ControlDown() :
             self.input_buffer = ''
         elif event.KeyCode == ord('A') and event.ControlDown() :
             self.GotoPos(self.GetLength())
             self.SetSelectionStart(self.current_prompt_pos)
             self.SetSelectionEnd(self.GetCurrentPos())
             catched = True
         elif event.KeyCode == ord('E') and event.ControlDown() :
             self.GotoPos(self.GetLength())
             catched = True
         elif event.KeyCode == wx.WXK_PAGEUP:
             self.ScrollPages(-1)
         elif event.KeyCode == wx.WXK_PAGEDOWN:
             self.ScrollPages(1)
         elif event.KeyCode == wx.WXK_UP and event.ShiftDown():
             self.ScrollLines(-1)
         elif event.KeyCode == wx.WXK_DOWN and event.ShiftDown():
             self.ScrollLines(1)
         else:
             catched = False
 
         if self.AutoCompActive():
             event.Skip()
         else:
             if event.KeyCode in (13, wx.WXK_NUMPAD_ENTER) and \
                         event.Modifiers in (wx.MOD_NONE, wx.MOD_WIN):
                 catched = True
                 self.CallTipCancel()
                 self.write('\n', refresh=False)
                 # Under windows scintilla seems to be doing funny stuff to the 
                 # line returns here, but the getter for input_buffer filters 
                 # this out.
                 if sys.platform == 'win32':
                     self.input_buffer = self.input_buffer
                 self._on_enter()
 
             elif event.KeyCode == wx.WXK_HOME:
                 if event.Modifiers in (wx.MOD_NONE, wx.MOD_WIN):
                     self.GotoPos(self.current_prompt_pos)
                     catched = True
 
                 elif event.Modifiers == wx.MOD_SHIFT:
                     # FIXME: This behavior is not ideal: if the selection
                     # is already started, it will jump.
                     self.SetSelectionStart(self.current_prompt_pos) 
                     self.SetSelectionEnd(self.GetCurrentPos())
                     catched = True
 
             elif event.KeyCode == wx.WXK_UP:
                 if self.GetCurrentLine() > self.current_prompt_line:
                     if self.GetCurrentLine() == self.current_prompt_line + 1 \
                             and self.GetColumn(self.GetCurrentPos()) < \
                                 self.GetColumn(self.current_prompt_pos):
                         self.GotoPos(self.current_prompt_pos)
                     else:
                         event.Skip()
                 catched = True
 
             elif event.KeyCode in (wx.WXK_LEFT, wx.WXK_BACK):
                 if self.GetCurrentPos() > self.current_prompt_pos:
                     event.Skip()
                 catched = True
 
             if skip and not catched:
                 # Put the cursor back in the edit region
                 if self.GetCurrentPos() < self.current_prompt_pos:
                     self.GotoPos(self.current_prompt_pos)
                 else:
                     event.Skip()
 
         return catched
 
 
     def _on_key_up(self, event, skip=True):
         """ If cursor is outside the editing region, put it back.
         """
         event.Skip()
         if self.GetCurrentPos() < self.current_prompt_pos:
             self.GotoPos(self.current_prompt_pos)
 
 
 
 if __name__ == '__main__':
     # Some simple code to test the console widget.
     class MainWindow(wx.Frame):
         def __init__(self, parent, id, title):
             wx.Frame.__init__(self, parent, id, title, size=(300,250))
             self._sizer = wx.BoxSizer(wx.VERTICAL)
             self.console_widget = ConsoleWidget(self)
             self._sizer.Add(self.console_widget, 1, wx.EXPAND)
             self.SetSizer(self._sizer)
             self.SetAutoLayout(1)
             self.Show(True)
 
     app = wx.PySimpleApp()
     w = MainWindow(None, wx.ID_ANY, 'ConsoleWidget')
     w.SetSize((780, 460))
     w.Show()
 
     app.MainLoop()
 
 

docs/source/changes.txt

@@ -1,252 +1,296 b''
 .. _changes:
 
 ==========
 What's new
 ==========
 
 .. contents::
 ..
     1  Release 0.9
       1.1  New features
       1.2  Bug fixes
       1.3  Backwards incompatible changes
       1.4  Changes merged in from IPython1
         1.4.1  New features
         1.4.2  Bug fixes
         1.4.3  Backwards incompatible changes
     2  Release 0.8.4
     3  Release 0.8.2
     4  Release 0.8.3
     5  Older releases
 ..
 
 
 Release 0.9
 ===========
 
 New features
 ------------
 
 * Laurent's WX application has been given a top-level script called ipython-wx,
   and it has received numerous fixes.  We expect this code to be
   architecturally better integrated with Gael's WX 'ipython widget' over the
   next few releases.
 
 * The Editor synchronization work by Vivian De Smedt has been merged in.  This
   code adds a number of new editor hooks to synchronize with editors under
   Windows.
 
 * A new, still experimental but highly functional, WX shell by Gael Varoquaux.
   This work was sponsored by Enthought, and while it's still very new, it is
   based on a more cleanly organized arhictecture of the various IPython
   components.  We will continue to develop this over the next few releases as a
   model for GUI components that use IPython.
 
 * Another GUI frontend, Cocoa based (Cocoa is the OSX native GUI framework),
   authored by Barry Wark.  Currently the WX and the Cocoa ones have slightly
   different internal organizations, but the whole team is working on finding
   what the right abstraction points are for a unified codebase.
 
 * As part of the frontend work, Barry Wark also implemented an experimental
   event notification system that various ipython components can use.  In the
   next release the implications and use patterns of this system regarding the
   various GUI options will be worked out.
 
 * IPython finally has a full test system, that can test docstrings with
   IPython-specific functionality.  There are still a few pieces missing for it
   to be widely accessible to all users (so they can run the test suite at any
   time and report problems), but it now works for the developers.  We are
   working hard on continuing to improve it, as this was probably IPython's
   major Achilles heel (the lack of proper test coverage made it effectively
   impossible to do large-scale refactoring).
 
-	* The notion of a task has been completely reworked.  An `ITask` interface has
-	  been created.  This interface defines the methods that tasks need to implement.
-	  These methods are now responsible for things like submitting tasks and processing
-	  results.  There are two basic task types: :class:`IPython.kernel.task.StringTask`
-	  (this is the old `Task` object, but renamed) and the new 
-	  :class:`IPython.kernel.task.MapTask`, which is based on a function.
-	* A new interface, :class:`IPython.kernel.mapper.IMapper` has been defined to
-	  standardize the idea of a `map` method.  This interface has a single
-	  `map` method that has the same syntax as the built-in `map`.  We have also defined
-	  a `mapper` factory interface that creates objects that implement
-	  :class:`IPython.kernel.mapper.IMapper` for different controllers.  Both
-	  the multiengine and task controller now have mapping capabilties.
-	* The parallel function capabilities have been reworks.  The major changes are that
-	  i) there is now an `@parallel` magic that creates parallel functions, ii)
-	  the syntax for mulitple variable follows that of `map`, iii) both the
-	  multiengine and task controller now have a parallel function implementation.
-	* All of the parallel computing capabilities from `ipython1-dev` have been merged into
-	  IPython proper.  This resulted in the following new subpackages:  
-	  :mod:`IPython.kernel`, :mod:`IPython.kernel.core`, :mod:`IPython.config`,
-	  :mod:`IPython.tools` and :mod:`IPython.testing`.
-	* As part of merging in the `ipython1-dev` stuff, the `setup.py` script and friends
-	  have been completely refactored.  Now we are checking for dependencies using
-	  the approach that matplotlib uses.
-	* The documentation has been completely reorganized to accept the documentation
-	  from `ipython1-dev`.
-	* We have switched to using Foolscap for all of our network protocols in
-	  :mod:`IPython.kernel`.  This gives us secure connections that are both encrypted
-	  and authenticated.
-	* We have a brand new `COPYING.txt` files that describes the IPython license
-	  and copyright.  The biggest change is that we are putting "The IPython
-	  Development Team" as the copyright holder.  We give more details about exactly
-	  what this means in this file.  All developer should read this and use the new
-	  banner in all IPython source code files.
-	* sh profile: ./foo runs foo as system command, no need to do !./foo anymore
-	* String lists now support 'sort(field, nums = True)' method (to easily
-	  sort system command output). Try it with 'a = !ls -l ; a.sort(1, nums=1)'
-	* '%cpaste foo' now assigns the pasted block as string list, instead of string
-	* The ipcluster script now run by default with no security.  This is done because
-	  the main usage of the script is for starting things on localhost.  Eventually
-	  when ipcluster is able to start things on other hosts, we will put security
-	  back.
-	* 'cd --foo' searches directory history for string foo, and jumps to that dir.
-	  Last part of dir name is checked first. If no matches for that are found,
-	  look at the whole path.
+* The notion of a task has been completely reworked.  An `ITask` interface has
+  been created.  This interface defines the methods that tasks need to implement.
+  These methods are now responsible for things like submitting tasks and processing
+  results.  There are two basic task types: :class:`IPython.kernel.task.StringTask`
+  (this is the old `Task` object, but renamed) and the new 
+  :class:`IPython.kernel.task.MapTask`, which is based on a function.
+
+* A new interface, :class:`IPython.kernel.mapper.IMapper` has been defined to
+  standardize the idea of a `map` method.  This interface has a single
+  `map` method that has the same syntax as the built-in `map`.  We have also defined
+  a `mapper` factory interface that creates objects that implement
+  :class:`IPython.kernel.mapper.IMapper` for different controllers.  Both
+  the multiengine and task controller now have mapping capabilties.
+
+* The parallel function capabilities have been reworks.  The major changes are that
+  i) there is now an `@parallel` magic that creates parallel functions, ii)
+  the syntax for mulitple variable follows that of `map`, iii) both the
+  multiengine and task controller now have a parallel function implementation.
+
+* All of the parallel computing capabilities from `ipython1-dev` have been merged into
+  IPython proper.  This resulted in the following new subpackages:  
+  :mod:`IPython.kernel`, :mod:`IPython.kernel.core`, :mod:`IPython.config`,
+  :mod:`IPython.tools` and :mod:`IPython.testing`.
+
+* As part of merging in the `ipython1-dev` stuff, the `setup.py` script and friends
+  have been completely refactored.  Now we are checking for dependencies using
+  the approach that matplotlib uses.
+
+* The documentation has been completely reorganized to accept the documentation
+  from `ipython1-dev`.
+
+* We have switched to using Foolscap for all of our network protocols in
+  :mod:`IPython.kernel`.  This gives us secure connections that are both encrypted
+  and authenticated.
+
+* We have a brand new `COPYING.txt` files that describes the IPython license
+  and copyright.  The biggest change is that we are putting "The IPython
+  Development Team" as the copyright holder.  We give more details about exactly
+  what this means in this file.  All developer should read this and use the new
+  banner in all IPython source code files.
+
+* sh profile: ./foo runs foo as system command, no need to do !./foo anymore
+
+* String lists now support 'sort(field, nums = True)' method (to easily
+  sort system command output). Try it with 'a = !ls -l ; a.sort(1, nums=1)'
+
+* '%cpaste foo' now assigns the pasted block as string list, instead of string
+
+* The ipcluster script now run by default with no security.  This is done because
+  the main usage of the script is for starting things on localhost.  Eventually
+  when ipcluster is able to start things on other hosts, we will put security
+  back.
+
+* 'cd --foo' searches directory history for string foo, and jumps to that dir.
+  Last part of dir name is checked first. If no matches for that are found,
+  look at the whole path.
 
 Bug fixes
 ---------
 
-	* The colors escapes in the multiengine client are now turned off on win32 as they
-	  don't print correctly.
-	* The :mod:`IPython.kernel.scripts.ipengine` script was exec'ing mpi_import_statement
-	  incorrectly, which was leading the engine to crash when mpi was enabled.
-	* A few subpackages has missing `__init__.py` files.
-	* The documentation is only created is Sphinx is found.  Previously, the `setup.py`
-	  script would fail if it was missing.
-	* Greedy 'cd' completion has been disabled again (it was enabled in 0.8.4)
+* The colors escapes in the multiengine client are now turned off on win32 as they
+  don't print correctly.
+
+* The :mod:`IPython.kernel.scripts.ipengine` script was exec'ing mpi_import_statement
+  incorrectly, which was leading the engine to crash when mpi was enabled.
+
+* A few subpackages has missing `__init__.py` files.
+
+* The documentation is only created is Sphinx is found.  Previously, the `setup.py`
+  script would fail if it was missing.
+
+* Greedy 'cd' completion has been disabled again (it was enabled in 0.8.4)
           
 
 Backwards incompatible changes
 ------------------------------
 
 * In ipapi, the :func:`make_user_ns` function has been replaced with
   :func:`make_user_namespaces`, to support dict subclasses in namespace
   creation.
 
-	* :class:`IPython.kernel.client.Task` has been renamed
-	  :class:`IPython.kernel.client.StringTask` to make way for new task types.
-	* The keyword argument `style` has been renamed `dist` in `scatter`, `gather`
-	  and `map`.
-	* Renamed the values that the rename `dist` keyword argument can have from
-	  `'basic'` to `'b'`.
-	* IPython has a larger set of dependencies if you want all of its capabilities.
-	  See the `setup.py` script for details.
-	* The constructors for :class:`IPython.kernel.client.MultiEngineClient` and 
-	  :class:`IPython.kernel.client.TaskClient` no longer take the (ip,port) tuple.
-	  Instead they take the filename of a file that contains the FURL for that
-	  client.  If the FURL file is in your IPYTHONDIR, it will be found automatically
-	  and the constructor can be left empty.
-	* The asynchronous clients in :mod:`IPython.kernel.asyncclient` are now created 
-	  using the factory functions :func:`get_multiengine_client` and 
-	  :func:`get_task_client`.  These return a `Deferred` to the actual client.
-	* The command line options to `ipcontroller` and `ipengine` have changed to
-	  reflect the new Foolscap network protocol and the FURL files.  Please see the
-	  help for these scripts for details.
-	* The configuration files for the kernel have changed because of the Foolscap stuff.
-	  If you were using custom config files before, you should delete them and regenerate
-	  new ones.
+* :class:`IPython.kernel.client.Task` has been renamed
+  :class:`IPython.kernel.client.StringTask` to make way for new task types.
+
+* The keyword argument `style` has been renamed `dist` in `scatter`, `gather`
+  and `map`.
+
+* Renamed the values that the rename `dist` keyword argument can have from
+  `'basic'` to `'b'`.
+
+* IPython has a larger set of dependencies if you want all of its capabilities.
+  See the `setup.py` script for details.
+
+* The constructors for :class:`IPython.kernel.client.MultiEngineClient` and 
+  :class:`IPython.kernel.client.TaskClient` no longer take the (ip,port) tuple.
+  Instead they take the filename of a file that contains the FURL for that
+  client.  If the FURL file is in your IPYTHONDIR, it will be found automatically
+  and the constructor can be left empty.
+
+* The asynchronous clients in :mod:`IPython.kernel.asyncclient` are now created 
+  using the factory functions :func:`get_multiengine_client` and 
+  :func:`get_task_client`.  These return a `Deferred` to the actual client.
+
+* The command line options to `ipcontroller` and `ipengine` have changed to
+  reflect the new Foolscap network protocol and the FURL files.  Please see the
+  help for these scripts for details.
+
+* The configuration files for the kernel have changed because of the Foolscap stuff.
+  If you were using custom config files before, you should delete them and regenerate
+  new ones.
 
 Changes merged in from IPython1
 -------------------------------
 
 New features
 ............
 
-	* Much improved ``setup.py`` and ``setupegg.py`` scripts.  Because Twisted
-	  and zope.interface are now easy installable, we can declare them as dependencies
-	  in our setupegg.py script.
-	* IPython is now compatible with Twisted 2.5.0 and 8.x.
-	* Added a new example of how to use :mod:`ipython1.kernel.asynclient`.
-	* Initial draft of a process daemon in :mod:`ipython1.daemon`.  This has not
-	  been merged into IPython and is still in `ipython1-dev`.
-	* The ``TaskController`` now has methods for getting the queue status.
-	* The ``TaskResult`` objects not have information about how long the task
-	  took to run.
-	* We are attaching additional attributes to exceptions ``(_ipython_*)`` that 
-	  we use to carry additional info around.
-	* New top-level module :mod:`asyncclient` that has asynchronous versions (that
-	  return deferreds) of the client classes.  This is designed to users who want
-	  to run their own Twisted reactor
-	* All the clients in :mod:`client` are now based on Twisted.  This is done by 
-	  running the Twisted reactor in a separate thread and using the
-	  :func:`blockingCallFromThread` function that is in recent versions of Twisted.
-	* Functions can now be pushed/pulled to/from engines using
-	  :meth:`MultiEngineClient.push_function` and :meth:`MultiEngineClient.pull_function`.
-	* Gather/scatter are now implemented in the client to reduce the work load
-	  of the controller and improve performance.
-	* Complete rewrite of the IPython docuementation.  All of the documentation
-	  from the IPython website has been moved into docs/source as restructured
-	  text documents.  PDF and HTML documentation are being generated using 
-	  Sphinx.
-	* New developer oriented documentation: development guidelines and roadmap. 
-	* Traditional ``ChangeLog`` has been changed to a more useful ``changes.txt`` file
-	  that is organized by release and is meant to provide something more relevant
-	  for users.
+* Much improved ``setup.py`` and ``setupegg.py`` scripts.  Because Twisted
+  and zope.interface are now easy installable, we can declare them as dependencies
+  in our setupegg.py script.
+
+* IPython is now compatible with Twisted 2.5.0 and 8.x.
+
+* Added a new example of how to use :mod:`ipython1.kernel.asynclient`.
+
+* Initial draft of a process daemon in :mod:`ipython1.daemon`.  This has not
+  been merged into IPython and is still in `ipython1-dev`.
+  
+* The ``TaskController`` now has methods for getting the queue status.
+
+* The ``TaskResult`` objects not have information about how long the task
+  took to run.
+  
+* We are attaching additional attributes to exceptions ``(_ipython_*)`` that 
+  we use to carry additional info around.
+  
+* New top-level module :mod:`asyncclient` that has asynchronous versions (that
+  return deferreds) of the client classes.  This is designed to users who want
+  to run their own Twisted reactor.
+  
+* All the clients in :mod:`client` are now based on Twisted.  This is done by 
+  running the Twisted reactor in a separate thread and using the
+  :func:`blockingCallFromThread` function that is in recent versions of Twisted.
+
+* Functions can now be pushed/pulled to/from engines using
+  :meth:`MultiEngineClient.push_function` and :meth:`MultiEngineClient.pull_function`.
+
+* Gather/scatter are now implemented in the client to reduce the work load
+  of the controller and improve performance.
+
+* Complete rewrite of the IPython docuementation.  All of the documentation
+  from the IPython website has been moved into docs/source as restructured
+  text documents.  PDF and HTML documentation are being generated using 
+  Sphinx.
+
+* New developer oriented documentation: development guidelines and roadmap. 
+
+* Traditional ``ChangeLog`` has been changed to a more useful ``changes.txt`` file
+  that is organized by release and is meant to provide something more relevant
+  for users.
 
 Bug fixes
 .........
 
-	* Created a proper ``MANIFEST.in`` file to create source distributions.
-	* Fixed a bug in the ``MultiEngine`` interface.  Previously, multi-engine 
-	  actions were being collected with a :class:`DeferredList` with 
-	  ``fireononeerrback=1``.  This meant that methods were returning 
-	  before all engines had given their results.  This was causing extremely odd 
-	  bugs in certain cases. To fix this problem, we have 1) set 
-	  ``fireononeerrback=0`` to make sure all results (or exceptions) are in 
-	  before returning and 2) introduced a :exc:`CompositeError` exception 
-	  that wraps all of the engine exceptions.  This is a huge change as it means 
-	  that users will have to catch :exc:`CompositeError` rather than the actual
-	  exception.
+* Created a proper ``MANIFEST.in`` file to create source distributions.
+
+* Fixed a bug in the ``MultiEngine`` interface.  Previously, multi-engine 
+  actions were being collected with a :class:`DeferredList` with 
+  ``fireononeerrback=1``.  This meant that methods were returning 
+  before all engines had given their results.  This was causing extremely odd 
+  bugs in certain cases. To fix this problem, we have 1) set 
+  ``fireononeerrback=0`` to make sure all results (or exceptions) are in 
+  before returning and 2) introduced a :exc:`CompositeError` exception 
+  that wraps all of the engine exceptions.  This is a huge change as it means 
+  that users will have to catch :exc:`CompositeError` rather than the actual
+  exception.
 
 Backwards incompatible changes
 ..............................
 
-	* All names have been renamed to conform to the lowercase_with_underscore
-	  convention.  This will require users to change references to all names like
-	  ``queueStatus`` to ``queue_status``.
-	* Previously, methods like :meth:`MultiEngineClient.push` and    	
-	  :meth:`MultiEngineClient.push` used ``*args`` and ``**kwargs``.  This was 
-	  becoming a problem as we weren't able to introduce new keyword arguments into
-	  the API.  Now these methods simple take a dict or sequence.  This has also allowed
-	  us to get rid of the ``*All`` methods like :meth:`pushAll` and :meth:`pullAll`.
-	  These things are now handled with the ``targets`` keyword argument that defaults
-	  to ``'all'``.
-	* The :attr:`MultiEngineClient.magicTargets` has been renamed to
-	  :attr:`MultiEngineClient.targets`. 
-	* All methods in the MultiEngine interface now accept the optional keyword argument
-	  ``block``.
-	* Renamed :class:`RemoteController` to :class:`MultiEngineClient` and 
-	  :class:`TaskController` to :class:`TaskClient`.
-	* Renamed the top-level module from :mod:`api` to :mod:`client`.
-	* Most methods in the multiengine interface now raise a :exc:`CompositeError` exception
-	  that wraps the user's exceptions, rather than just raising the raw user's exception.
-	* Changed the ``setupNS`` and ``resultNames`` in the ``Task`` class to ``push`` 
-	  and ``pull``.
+* All names have been renamed to conform to the lowercase_with_underscore
+  convention.  This will require users to change references to all names like
+  ``queueStatus`` to ``queue_status``.
+
+* Previously, methods like :meth:`MultiEngineClient.push` and    	
+  :meth:`MultiEngineClient.push` used ``*args`` and ``**kwargs``.  This was 
+  becoming a problem as we weren't able to introduce new keyword arguments into
+  the API.  Now these methods simple take a dict or sequence.  This has also allowed
+  us to get rid of the ``*All`` methods like :meth:`pushAll` and :meth:`pullAll`.
+  These things are now handled with the ``targets`` keyword argument that defaults
+  to ``'all'``.
+
+* The :attr:`MultiEngineClient.magicTargets` has been renamed to
+  :attr:`MultiEngineClient.targets`. 
+
+* All methods in the MultiEngine interface now accept the optional keyword argument
+  ``block``.
+
+* Renamed :class:`RemoteController` to :class:`MultiEngineClient` and 
+  :class:`TaskController` to :class:`TaskClient`.
+
+* Renamed the top-level module from :mod:`api` to :mod:`client`.
+
+* Most methods in the multiengine interface now raise a :exc:`CompositeError` exception
+  that wraps the user's exceptions, rather than just raising the raw user's exception.
+
+* Changed the ``setupNS`` and ``resultNames`` in the ``Task`` class to ``push`` 
+  and ``pull``.
 
 Release 0.8.4
 =============
 
 Someone needs to describe what went into 0.8.4.
 
 Release 0.8.2
 =============
 
 * %pushd/%popd behave differently; now "pushd /foo" pushes CURRENT directory 
   and jumps to /foo. The current behaviour is closer to the documented 
   behaviour, and should not trip anyone.
   
 Release 0.8.3
 =============
   
 * pydb is now disabled by default (due to %run -d problems). You can enable
   it by passing -pydb command line argument to IPython. Note that setting
   it in config file won't work.
 
 Older releases
 ==============
 
 Changes in earlier releases of IPython are described in the older file ``ChangeLog``.  
 Please refer to this document for details.
 

docs/source/index.txt

@@ -1,28 +1,32 b''
 =====================
 IPython Documentation
 =====================
 
-Contents
-========
+.. htmlonly::
+
+   :Release: |version|
+   :Date: |today|
+
+   Contents:
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    overview.txt
    install/index.txt
    interactive/index.txt
    parallel/index.txt
    config/index.txt
    changes.txt
    development/index.txt
    faq.txt
    history.txt
    license_and_copyright.txt
    credits.txt
 
-Indices and tables
-==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
  No newline at end of file
+.. htmlonly::
+
+  * :ref:`genindex`
+  * :ref:`modindex`
+  * :ref:`search`

docs/source/install/index.txt

@@ -1,11 +1,10 b''
 .. _install_index:
 
 ==================
 Installation
 ==================
 
 .. toctree::
    :maxdepth: 2
 
-   basic.txt
-   advanced.txt
+   install.txt