This file describes user-visible changes between the extension versions.
- Drops support for Python 2.6 and 3.3 (may still work, but no longer tested)
- Adds support for Python 3.7
- Automatically adds 'sphinx.ext.autodoc' extension if needed
- Improved rendering of "Raises" section
- Improved type rendering for "Attributes" section
- Improved support for inline attribute docstrings
- Adds :ivar: type qualification
- Adds user defined custom sections
- Adds the following system defined sections:
- Attention
- Caution
- Danger
- Error
- Hint
- Important
- Tip
- Excludes tests directory from package contents
- No longer prevents other 'autodoc-skip-member' handlers from running. If Napoleon doesn't care if a member is skipped, then the decision is deferred to autodoc and other extensions that handle 'autodoc-skip-member'.
- Improves param type parsing
- Fixes parsing of Google style parameter types that contain parenthesis
- Fixes issue in which monkey patching :keyword: support breaks with older versions of Sphinx (at least sphinx<=1.2.3)
- 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
- Adds config option "napoleon_include_init_with_doc" to force inclusion of standalone __init__ method in generated docs
- Adds config option "napoleon_use_keyword" to render keyword args with type links
- Removes dependency on Sphinx, allows non-sphinx projects to use napoleon
- Fixes issue in which bulleted lists in parameter descriptions could cause the sphinx builder to fail
- Fixes bad Python 3.2 syntax ('u' string literal)
- Sets napoleon_include_special_with_doc to False by default
- Removes upper bound on required Sphinx version (sphinx>=1.3 now allowed)
- Adds support for Todo section header and Todo extension integration
- Changes __unicode__ to conditionally use "u" literal string for Python 3.2 compatibility
- NumpyDoc section headers may be delimited by two or more underline characters
- Google style section headers must be followed by exactly one colon
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
- 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
- Fixes formatting in Raises section when type contains cross references
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
- Removes docutils inline parser because it is incompatible with more recent versions of docutils.
- Uses docutils to parse inline markup in params, attributes, return types...
- Correctly handles Return types containing colons in Google-style docstrings
- Adds support for "Usage" section
- Correctly handles Return types containing colons in NumPy-style docstrings
- Removes 2to3 from setup.py
- Enables bdist_wheel distributions
- 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
- Fix Google Docstring argument regex. Argument types now more permissive, allowing spaces and other special characters.
- Adds "Yield" alias for "Yields" section
- Fixes bug which silently omitted *args and **kwargs parameters
- Fixes bug where ignored parameter if description is empty
- Fixes bug which failed to render links in attribute types
- Fixes import error when processing namedtuples
- Adds Python 3.4 as a tox environment
- Fixes "Args:" type parsing bug in Google style docs
- 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
- Drops official support for 3.1
- Brings code into parity with Sphinx 1.3 "sphinx.ext.napoleon"
- Restricts allowable Sphinx version to < 1.3
- Adds python 3.1 support
- Fixes tests for python 3.*
- Adds tox environments: py26,py27,py31,py32,py33,pypy
- Adds python 3 support
- Corrects package url in setup.py
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)
- Adds documentation.
- Fixes API docs for pavertasks.
- Initial version.