Changelog

Version 1.6.0

To be released.

• Added groupby option to :rst:`.. autoflask::` directive. It makes paths be grouped by their view functions. [:pull:`147` by Jiangge Zhang]
• Fixed a bug that autoflask directive had excluded nonsignificant routes with :http:method:`HEAD`/:http:method:`OPTIONS`. [:issue:`165`]

Version 1.5.0

Released on May 30, 2016.

• Added sphinxcontrib.autohttp.flaskqref for generating quick reference table. [:pull:`80`, :pull:`100` by Harry Raaymakers]
• autoflask now supports :modules: and :undoc-modules: arguments, used to filter documented flask endpoints by view module [:pull:`102` by Ivelin Slavov]
• Added :order: option to autoflask directive. [:pull:`103` by Justin Gruca]
• HTTP message headers become to link the recent RFCs (RFC 7230, RFC 7231, RFC 7232, RFC 7233, RFC 7234, RFC 7235, RFC 7236, RFC 7237, that are separated to multiple RFCs from the old one) instead of RFC 2615 which is replaced by them in 2014. [:pull:`105`, :pull:`106` by Alex C. (iscandr)]
• Support resolve_any_xref method introduced since Sphinx 1.3 [:pull:`108` by Takayuki Shimizukawa]
• It no more warns non-standard message headers without X- prefix according as the deprecation of the practice of prefixing the names of unstandardized parameters with X- in all IETF protocols since June 2012 by RFC 6648. [:pull:`114` by Dolan Murvihill]
• Fixed performance bottleneck in doctree lookup by adding a cache for it. [:pull:`115` by Kai Lautaportti]
• Added :http:statuscode:`451` to http:statuscode. [:pull:`117` by Xavier Oliver]

Version 1.4.0

Released on August 13, 2015.

• Added :http:statuscode:`429 Too Many Requests` as a valid http:statuscode. [:pull:`81` by DDBReloaded]
• Became to not resolve references if they can’t be resolved. [:pull:`87` by Ken Robbins]
• Became to preserve endpoint ordering when :endpoints: option is given. [:pull:`88` by Dan Callaghan]
• Added status codes for WebDAV. [:pull:`92` by Ewen Cheslack-Postava]
• Added CORS headers. [:pull:`96` by Tomi Pieviläinen]
• Now sphinxcontrib.autohttp.flask supports multiple paths for endpoints using same HTTP method. [:pull:`97` by Christian Felder]

Version 1.3.0

Released on July 31, 2014.

• jsonparameter/jsonparam/json became deprecated and split into reqjsonobj/reqjson/<jsonobj/<json and reqjsonarr/<jsonarr. [:issue:`55`, :pull:`72` by Alexander Shorin]
• Support synopsis (short description in HTTP index), deprecation and noindex options for resources. [:issue:`55`, :pull:`72` by Alexander Shorin]
• Stabilize order of index items. [:issue:`55`, :pull:`72` by Alexander Shorin]
• Added http:any directive and http:any role for ANY method. [:issue:`55`, :pull:`72` by Alexander Shorin]
• Added http:copy directive and http:copy role for COPY method. [:issue:`55`, :pull:`72` by Alexander Shorin]
• Added http:header role that also creates reference to the related specification. [:issue:`55`, :pull:`72` by Alexander Shorin]
• http:statuscode role became to provide references to specification sections. [:issue:`55`, :pull:`72` by Alexander Shorin]
• Fixed Python 3 incompatibility of autohttp.tornado. [:pull:`61` by Dave Shawley]

Version 1.2.1

Released on March 31, 2014.

• Fixed broken Python 2.6 compatibility. [:pull:`41` by Kien Pham]
• Added missing link to six dependency.

Version 1.2.0

Released on October 19, 2013.

• Python 3 support! [:pull:`34` by murchik, :pull:`39` Donald Stufft]
• Added support for Tornado webapps. (sphinxcontrib.autohttp.tornado) [:pull:`38` by Rodrigo Machado]

Version 1.1.9

Released on August 8, 2013.

• Now Bottle_ apps can be loaded by autohttp. See sphinxcontrib.autohttp.bottle module. [patch by Jameel Al-Aziz]
• Added :reqheader: and :resheader: option flags.
• :jsonparameter: can be typed. [:pull:`31` by Chuck Harmston]
• :queryparameter: can be typed. [:pull:`37` by Viktor Haag]
• autoflask and autobottle directives now allow empty :endpoints:, :undoc-endpoints:, and :blueprints: arguments. [:pull:`33` by Michael Twomey]

Version 1.1.8

Released on April 10, 2013.

• Added better support for docstrings in flask.views.MethodView. [:pull:`26` by Simon Metson]
• Added :jsonparameter: along side :form: and :query: flag options. [:pull:`25` by Adam Lowry]
• Fixed issue with undefined Value and umethod variables. [:pull:`23` by Sebastian Kalinowski and :pull:`24` by Viktor Haag]
• Now http Pygments lexer can Handle continuous header lines well.
• Added :undoc-blueprints: flag option to autoflask directive. [:pull:`21` by Roman Podolyaka]
• Fixed :issue:`29`, a bug that autoflask directive raised UnicodeDecodeError when it contains non-ASCII characters. [:issue:`29` and :pull:`18` by Eunchong Yu]
• Added :endpoints: flag option to autoflask directive. [:pull:`17` by Eunchong Yu]

Version 1.1.7

Released on March 28, 2012.

• Added :http:method:`PATCH` method support. See http:patch role and http:patch directive. [:pull:`9` and :pull:`10` by Jeffrey Finkelstein]
• The HTTP routing table can be grouped based on prefix by specifying http_index_ignore_prefixes config in list of common prefixes to ignore. [:pull:`7` and :pull:`8` by Andrey Popp]
• The order of HTTP routing table now provides sorting by path as key. Previously it was sorted by HTTP method and then by path, which is non-intuitive. [:pull:`7` and :pull:`8` by Andrey Popp]

Version 1.1.6

Released on December 16, 2011.

• Added http custom lexer for Pygments so that HTTP sessions can be highlighted in code-block or sourcecode directives.

Version 1.1.5

Released on July 6, 2011.

• Flask 0.6–0.7 compatibility. Flask renamed static_path attribute to static_url_path, so autoflask also reflect the change. [:pull:`1` by Jeffrey Finkelstein]

Version 1.1.4

Released on June 8, 2011.

• CPython compatibility
• PyPy compatibility

Version 1.1.3

Released on June 8, 2011.

• PyPy compatibility

Version 1.1.2

Released on June 4, 2011.

• Added :include-empty-docstring: flag option.

Version 1.1.1

Released on June 4, 2011.

• Fixed a backward incompatibility bug.

Version 1.1

Released on June 4, 2011.

• Added autoflask directive.

Version 1.0

Released on June 2, 2011. The first release.