Sphinx-autoapi

-------------------

Features
^^^^^^^^

- (Python) Can read per argument type comments with astroid > 2.2.5.
- (Python) Added autoapidecorator directive with Sphinx >= 2.0.
- (Python) Can use autodoc_docstring_signature with Autodoc-style directives.
- (Python) Added autoapi-skip-member event.
- Made it more clear which file causes an error, when an error occurs.
- Sphinx language domains are now optional dependencies.

Bug Fixes
^^^^^^^^^

- (Python) Forward reference annotations are no longer rendered as strings.
- (Python) autoapifunction directive no longer documents async functions as
a normal function.
- (Python) Fixed unicode decode errors in some Python 3 situations.
- Documentation more accurately describes what configuration accepts
relative paths and where they are relative to.

-------------------

Features
^^^^^^^^

- (Python) Can override ignoring local imports in modules by using __all__.

Bug Fixes
^^^^^^^^^

- (Python) Fixed incorrect formatting of functions and methods.
- Added support for Sphinx 2.1.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^

- Fixed some dead links in the README.
- Fixed lint virtualenv.

-------------------

Features
^^^^^^^^

- `100 <https://github.com/readthedocs/sphinx-autoapi/issues/100>`: (Python)
Added support for documenting C extensions via ``.pyi`` stub files.
- Added support for Sphinx 2.0.
- Toned down the API reference index page.
- (Go) Patterns configured in ``autoapi_ignore`` are passed to godocjson.
- New and improved documentation.
- No longer need to set ``autoapi_add_toctree_entry`` to False when ``autoapi_generate_api_docs`` is False.
- `139 <https://github.com/readthedocs/sphinx-autoapi/issues/139>`
Added support for basic type annotations in documentation generation and autodoc-style directives.

Bug Fixes
^^^^^^^^^

- `159 <https://github.com/readthedocs/sphinx-autoapi/issues/159>`: (Python)
Fixed ``UnicodeDecodeError`` on Python 2 when a documenting an attribute that contains binary data.
- (Python) Fixed private submodules displaying when ``private-members`` is turned off.
- Templates no longer produce excessive whitespace.
- (Python) Fixed an error when giving an invalid object to an autodoc-style directive.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^

- No longer pin the version of black.
- Added missing test environments to travis.

-------------------

Bug Fixes
^^^^^^^^^

- (Python) Fixed a false warning when importing a local module.

-------------------

Breaking Changes
^^^^^^^^^^^^^^^^

- Dropped support for Sphinx<1.6.

Features
^^^^^^^^

- Added debug messages about what AutoAPI is doing.

Bug Fixes
^^^^^^^^^

- `156 <https://github.com/readthedocs/sphinx-autoapi/issues/156>`: (Python) Made import resolution more stable.

Also capable of giving more detailed warnings.


Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^

- Code is now formatted using black.
- Removed references to old css and js files.
- Replaced usage of deprecated Sphinx features.
- Reorganised tests to be more pytest-like.

-------------------

Bug Fixes
^^^^^^^^^

- (Python) Fixed some import chains failing to resolve depending on resolution order.