Changelog

Version 1.8.0

Released on September 23, 2020

• Make the generated routing table referencable using the ‘routingtable’ label. [pull request #19 by David Douard]
• Add support for parallel sphinx builds. Increases sphinx version requirement to 1.6 [pull request #31 by Daniel Hofmann]
• Remove references to the generic :py:obj: role [pull request #54 by Stephen Finucane]
• Remove imports and calls to depracated function force_decode who was removed starting with sphinx 4.0 [pull request #49 by Florian Masy]
• Be explicit about what versions of Python are supports (2.7, and 3.5+). This will be the last version to support Python 2.7 and 3.5, version 2.0 will require 3.6+.

Version 1.7.0

Released on July 1, 2018.

• Implemented :autoquickref: option that use available informations to build a quickref. [pull request #9 by Alexandre Bonnetain]
• Improved sphinxcontrib.autohttp.tornado compatibility with Tornado 4.5 and newer. Tornado 4.5 introduced the Rule class and made URLSpec a subclass of it, so certain rule attributes required updating. [issue #7, pull request #11 by Robert Zeigler]

Version 1.6.1

Released on March 3, 2018.

• Remove references to the sphinx.util.compat module which was deprecated in Sphinx 1.6 and removed in 1.7. [issue #5, pull request #4 by Jeremy Cline]
• Made sphinxcontrib.autohttp.tornado compatible with Tornado 4.5 and newer. Tornado 4.5 removed the handlers attribute from tornado.web.Application. [pull request #3 by Dave Shawley]

Version 1.6.0

Released on January 13, 2018.

• Minimum compatible version of Sphinx became changed to 1.5.
• Fixed a bug that prevented building sphinxcontrib.autohttp from building properly with Sphinx 1.6 or higher. [old issue #182, old pull request #152 by Dave Shawley]
• Use HTTPS for :rfc: generated links. [old pull request #144 by Devin Sevilla]
• Added groupby option to autoflask directive. It makes paths be grouped by their view functions. [old pull request #147 by Jiangge Zhang]
• Fixed a bug that autoflask directive had excluded nonsignificant routes with HEAD/OPTIONS. [old issue #165]

Version 1.5.0

Released on May 30, 2016.

• Added sphinxcontrib.autohttp.flaskqref for generating quick reference table. [old pull request #80, old pull request #100 by Harry Raaymakers]
• autoflask now supports :modules: and :undoc-modules: arguments, used to filter documented flask endpoints by view module [old pull request #102 by Ivelin Slavov]
• Added :order: option to autoflask directive. [old pull request #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. [old pull request #105, old pull request #106 by Alex C. (iscandr)]
• Support resolve_any_xref method introduced since Sphinx 1.3 [old pull request #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. [old pull request #114 by Dolan Murvihill]
• Fixed performance bottleneck in doctree lookup by adding a cache for it. [old pull request #115 by Kai Lautaportti]
• Added 451 Unavailable For Legal Reasons to http:statuscode. [old pull request #117 by Xavier Oliver]

Version 1.4.0

Released on August 13, 2015.

• Added 429 Too Many Requests as a valid http:statuscode. [old pull request #81 by DDBReloaded]
• Became to not resolve references if they can’t be resolved. [old pull request #87 by Ken Robbins]
• Became to preserve endpoint ordering when :endpoints: option is given. [old pull request #88 by Dan Callaghan]
• Added status codes for WebDAV. [old pull request #92 by Ewen Cheslack-Postava]
• Added CORS headers. [old pull request #96 by Tomi Pieviläinen]
• Now sphinxcontrib.autohttp.flask supports multiple paths for endpoints using same HTTP method. [old pull request #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. [old issue #55, old pull request #72 by Alexander Shorin]
• Support synopsis (short description in HTTP index), deprecation and noindex options for resources. [old issue #55, old pull request #72 by Alexander Shorin]
• Stabilize order of index items. [old issue #55, old pull request #72 by Alexander Shorin]
• Added http:any directive and http:any role for ANY method. [old issue #55, old pull request #72 by Alexander Shorin]
• Added http:copy directive and http:copy role for COPY method. [old issue #55, old pull request #72 by Alexander Shorin]
• Added http:header role that also creates reference to the related specification. [old issue #55, old pull request #72 by Alexander Shorin]
• http:statuscode role became to provide references to specification sections. [old issue #55, old pull request #72 by Alexander Shorin]
• Fixed Python 3 incompatibility of autohttp.tornado. [old pull request #61 by Dave Shawley]

Version 1.2.1

Released on March 31, 2014.

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

Version 1.2.0

Released on October 19, 2013.

• Python 3 support! [old pull request #34 by murchik, old pull request #39 Donald Stufft]
• Added support for Tornado webapps. (sphinxcontrib.autohttp.tornado) [old pull request #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. [old pull request #31 by Chuck Harmston]
• :queryparameter: can be typed. [old pull request #37 by Viktor Haag]
• autoflask and autobottle directives now allow empty :endpoints:, :undoc-endpoints:, and :blueprints: arguments. [old pull request #33 by Michael Twomey]

Version 1.1.8

Released on April 10, 2013.

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

Version 1.1.7

Released on March 28, 2012.

• Added PATCH method support. See http:patch role and http:patch directive. [old pull request #9 and old pull request #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. [old pull request #7 and old pull request #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. [old pull request #7 and old pull request #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. [old pull request #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.