beanbag-docutils 1.7¶
Release date: June 14, 2018
New Features¶
Added compatibility with Python 3.
This package now supports Python 2.7 and 3.4 through 3.6.
Added new documentation sections for the Beanbag documentation format.
This is enabled when using
beanbag_docutils.sphinx.ext.autodoc_utils
withnapoleon_beanbag_docstring = True
.This adds:
Deprecated
:A version in which something is deprecated, and an optional description. This is similar to the ReST
deprecated
directive.Version Added
:A version in which something is added, and an optional description. This is similar to the ReST
versionadded
directive.Version Changed
:A version in which something is changed, and an optional description. This is similar to the ReST
versionchanged
directive.
Added a Sphinx extension (
beanbag_docutils.sphinx.ext.ref_utils
) for improving code references.This currently enhances references, allowing both Python and JavaScript references to break paths (like
foo.bar.MyClass
) across multiple lines.To install this extension, add the following to your
conf.py
:extensions = [ ... 'beanbag_docutils.sphinx.ext.ref_utils', ... ]
Bug Fixes¶
Fixed handling of multi-line argument types when using the Beanbag documentation format support.
This addresses a case where spaces after a type (such as
int, optional
) would be lost.
Contributors¶
Christian Hammond