beanbag-docutils 1.4¶
Release date: May 25, 2017
New Features¶
Added a parser for the Beanbag documentation format.
This is part of
beanbag_docutils.sphinx.ext.autodoc_utils
, and is enabled when settingnapoleon_beanbag_docstring = True
inconf.py
. It replaces the Google and Numpy docstring formats, but requiressphinx.ext.napoleon
.This currently supports:
Context
:Describes what happens within the context of a context manager.
Model Attributes
:Describes the attributes on a Backbone.js model.
Option Args
:Describes options available to a function in JavaScript.
This parser also allows types (used in
Args
and other sections) to be wrapped across lines.
Contributors¶
Christian Hammond