Better version history information

NEWS.rst

@@ -0,0 +1,25 @@
+Release History
+---------------
+
+
+0.3 (2011-12-XX)
+~~~~~~~~~~~~~~~~
+
+* Moved version number to a VERSION.txt file (read by both docs and setup.py)
+* Added NEWS.rst (and incorporated into documentation)
+
+0.2 (2011-12-15)
+~~~~~~~~~~~~~~~~
+
+* Renamed CleanupManager to ContextStack (hopefully before anyone started
+  using the module for anything, since I didn't alias the old name at all)
+
+0.1 (2011-12-13)
+~~~~~~~~~~~~~~~~
+
+* Initial release as a backport module
+* Added CleanupManager (based on a `Python feature request`_)
+* Added ContextDecorator.refresh_cm() (based on a `Python tracker issue`_)
+  
+.. _Python feature request: http://bugs.python.org/issue13585
+.. _Python tracker issue: http://bugs.python.org/issue11647

docs/index.rst

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-contextlib2 --- Updated utilities for with-statement contexts
-=============================================================
+contextlib2 --- Updated utilities for context management
+========================================================
 
 .. module:: contextlib2
    :synopsis: Backports and future enhancements for the contextlib module
@@ -26,12 +26,12 @@ This module is primarily a backport of the Python 3.2 version of
 for new features not yet part of the standard library. Those new features
 are currently:
 
-* :meth:`ContextDecorator.refresh_cm`
 * :class:`ContextStack`
+* :meth:`ContextDecorator.refresh_cm`
 
 
 API Reference
--------------
+=============
 
 .. function:: @contextmanager
 
@@ -188,6 +188,9 @@ API Reference
       This may involve keeping a copy of the original arguments used to
       first initialise the context manager.
 
+   .. versionchanged:: 0.1
+      Made the standard library's private :meth:`refresh_cm` API public
+
 
 .. class:: ContextStack()
 
@@ -249,6 +252,9 @@ API Reference
       callbacks registered, the arguments passed in will indicate that no
       exception occurred.
 
+   .. versionadded:: 0.2
+      New API for :mod:`contextlib2`, not available in standard library
+
 
 Obtaining the Module
 ====================
@@ -281,9 +287,11 @@ improvements can be posted to the `issue tracker`_.
 .. _issue tracker: https://bitbucket.org/ncoghlan/contextlib2/issues?status=new&status=open
 
 
+.. include:: ../NEWS.rst
+
+
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`search`
-