.. -*- restructuredtext -*-

This file describes user-visible changes between the extension versions.


Version 0.5.1 (2016-06-12)
--------------------------

 * Fixes bad formatting when a literal block is opened on the first line of a
   parameter description
 * Corrects minor formatting issue on example NumPy Attributes section


Version 0.5.0 (2016-02-20)
--------------------------

 * Removes dependency on Sphinx, allows non-sphinx projects to use napoleon


Version 0.4.4 (2016-01-27)
--------------------------

 * Fixes issue in which bulleted lists in parameter descriptions could cause
   the sphinx builder to fail


Version 0.4.3 (2015-11-20)
--------------------------

 * Backslash escape asterisks in *args and **kwargs for NumPy docstrings


Version 0.4.2 (2015-11-18)
--------------------------

 * Fixes bad Python 3.2 syntax ('u' string literal)


Version 0.4.1 (2015-11-17)
--------------------------

 * Sets napoleon_include_special_with_doc to False by default
 * Removes upper bound on required Sphinx version (sphinx>=1.3 now allowed)


Version 0.4 (2015-11-17)
------------------------

 * Adds support for Todo section header and Todo extension integration
 * Changes __unicode__ to conditionally use "u" literal string for
   Python 3.2 compatibility


Version 0.3.11 (2015-07-24)
---------------------------

* NumpyDoc section headers may be delimited by two or more underline characters
* Google style section headers must be followed by exactly one colon


Version 0.3.10 (2015-06-11)
---------------------------

* Undoes formatting changes in version 0.3.7
* Description ALWAYS starts on same line as type in output::

    attr (type): description

  renders as::

    .. attribute:: attr

       *type* -- description

  whereas::

    attr (type):
        description

  ALSO renders as::

    .. attribute:: attr

       *type* -- description


Version 0.3.9 (2015-06-10)
--------------------------

* Formatting in Raises section updated to match Args, Returns, Yields, etc...
* If a newline is present immediately after the colon in Raises section, then
  the output will also have a line break, with no m-dash separator


Version 0.3.8 (2015-06-10)
--------------------------

* Fixes formatting in Raises section when type contains cross references


Version 0.3.7 (2015-06-09)
--------------------------

* Adds explicit type parsing for inline attribute and @property docs.
* Attribute types are no longer rendered on a separate line if the source
  docstring did not use a newline after the type::

    attr (type): description

  renders as::

    .. attribute:: attr

       *type* -- description

  whereas::

    attr (type):
        description

  renders as::

    .. attribute:: attr

       *type*

       description


Version 0.3.6 (2015-05-27)
--------------------------

* Removes docutils inline parser because it is incompatible with more recent
  versions of docutils.


Version 0.3.5 (2015-05-27)
--------------------------

* Uses docutils to parse inline markup in params, attributes, return types...


Version 0.3.4 (2015-05-03)
--------------------------

* Correctly handles Return types containing colons in Google-style docstrings


Version 0.3.3 (2015-04-03)
--------------------------

* Adds support for "Usage" section


Version 0.3.2 (2015-04-03)
--------------------------

* Correctly handles Return types containing colons in NumPy-style docstrings


Version 0.3.1 (2015-02-19)
--------------------------

* Removes 2to3 from setup.py
* Enables bdist_wheel distributions


Version 0.3 (2015-02-19)
------------------------

* Adds six dependency
* Adds pockets dependency
* Removes iterators module (now found in pockets package)
* Removes pavertasks module, deemed redundant as it simply called sphinx-apidoc


Version 0.2.11 (2015-02-15)
---------------------------

* Fix Google Docstring argument regex. Argument types now more permissive,
  allowing spaces and other special characters.


Version 0.2.10 (2015-02-09)
---------------------------

* Adds "Yield" alias for "Yields" section


Version 0.2.9 (2015-01-12)
--------------------------

* Fixes bug which silently omitted *args and **kwargs parameters
* Fixes bug where ignored parameter if description is empty


Version 0.2.8 (2014-06-13)
--------------------------

* Fixes bug which failed to render links in attribute types


Version 0.2.7 (2014-04-19)
--------------------------

* Fixes import error when processing namedtuples
* Adds Python 3.4 as a tox environment


Version 0.2.6 (2014-03-21)
--------------------------

* Fixes "Args:" type parsing bug in Google style docs


Version 0.2.5 (2014-03-11)
--------------------------

* Fixes Python 3.3 bug which included private and special members in the docs
* Fixes bug which failed to render links in function parameter types
* Adds support for See Also refs written using the NumpyDoc style
* Uses unittest.mock for Python >= 3.3


Version 0.2.4 (2014-01-21)
--------------------------

* Drops official support for 3.1
* Brings code into parity with Sphinx 1.3 "sphinx.ext.napoleon"
* Restricts allowable Sphinx version to < 1.3


Version 0.2.3 (2014-01-16)
--------------------------

* Adds python 3.1 support
* Fixes tests for python 3.*
* Adds tox environments: py26,py27,py31,py32,py33,pypy


Version 0.2.2 (2013-12-13)
--------------------------

* Adds python 3 support


Version 0.2.1 (2013-07-26)
--------------------------

* Corrects package url in setup.py


Version 0.2 (2013-07-26)
------------------------

* Adds special handling for ``Keyword Arguments``
* Adds aliases for common section headers:

    * ``Args`` *(alias of Parameters)*
    * ``Arguments`` *(alias of Parameters)*
    * ``Keyword Args`` *(alias of Keyword Arguments)*
    * ``Return`` *(alias of Returns)*
    * ``Warnings`` *(alias of Warning)*


Version 0.1.1 (2013-07-19)
--------------------------

* Adds documentation.
* Fixes API docs for pavertasks.


Version 0.1 (2013-07-18)
------------------------

* Initial version.
