Sphinx-autoapi

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

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

- Dropped support for Python 2 and Sphinx 1.x/2.x.
Python 2 source code can still be parsed.

Features
^^^^^^^^

- (Python) Added support for using type hints as parameter types and return types
via the ``sphinx.ext.autodoc.typehints`` extension.
- `191 <https://github.com/readthedocs/sphinx-autoapi/issues/191>`:
Basic incremental build support is enabled ``autoapi_keep_files`` is enabled.
Providing none of the source files have changed,
AutoAPI will skip parsing the source code and regenerating the API documentation.
- `200 <https://github.com/readthedocs/sphinx-autoapi/issues/200>`:
Can pass a callback that edits the Jinja Environment object before
template rendering begins.
This allows custom filters, tests, and globals to be added to the environment.
- Added support for Python 3.9.

Bug Fixes
^^^^^^^^^

- `246 <https://github.com/readthedocs/sphinx-autoapi/issues/246>`: (Python)
Fixed TypeError when parsing a class that inherits from ``type``.
- `244 <https://github.com/readthedocs/sphinx-autoapi/issues/244>`:
Fixed an unnecessary deprecation warning being raised when running
sphinx-build from the same directory as conf.py.
- (Python) Fixed properties documented by Autodoc directives getting documented as methods.

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

Bug Fixes
^^^^^^^^^

- Fixed AttributeError when generating an inheritance diagram for a module.

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

This will be the last minor version to support Python 2 and Sphinx 1.x/2.x.

Features
^^^^^^^^

- `222 <https://github.com/readthedocs/sphinx-autoapi/issues/222>`:
Declare the extension as parallel unsafe.
- `217 <https://github.com/readthedocs/sphinx-autoapi/issues/217>`: (Python)
All overload signatures are documented.
- `243 <https://github.com/readthedocs/sphinx-autoapi/issues/243>`:
Files are found in order of preference according to ``autoapi_file_patterns``.
- Added support for Sphinx 3.2.

Bug Fixes
^^^^^^^^^

- `219 <https://github.com/readthedocs/sphinx-autoapi/issues/219>`: (Python)
Fixed return types not showing for methods.
- (Python) Fixed incorrect formatting of properties on generated method directives.
- Fixed every toctree entry getting added as a new list.
- `234 <https://github.com/readthedocs/sphinx-autoapi/issues/234>`:
Fixed only some entries getting added to the toctree.

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

- autoapisummary directive inherits from autosummary for future stability.

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

Features
^^^^^^^^

- `197 <https://github.com/readthedocs/sphinx-autoapi/issues/197>`: Added
``autoapi.__version__`` and ``autoapi.__version_info__`` attributes
for accessing version information.
- `201 <https://github.com/readthedocs/sphinx-autoapi/issues/201>`: (Python)
Added the ``autoapi_member_order`` option to allow the order that members
are documented to be configurable.
- `203 <https://github.com/readthedocs/sphinx-autoapi/issues/203>`: (Python)
A class without a docstring inherits one from its parent.
A methods without a docstring inherits one from the method that it overrides.
- `204 <https://github.com/readthedocs/sphinx-autoapi/issues/204>`: (Python)
Added the ``imported-members`` AutoAPI option to be able to enable or disable
documenting objects imported from the same top-level package or module
without needing to override templates.

Bug Fixes
^^^^^^^^^

- `198 <https://github.com/readthedocs/sphinx-autoapi/issues/198>`:
Documentation describes the required layout for template override directories.
- `195 <https://github.com/readthedocs/sphinx-autoapi/issues/195>`: (Python)
Fixed incorrect formatting when ``show-inheritance-diagram``
and ``private-members`` are turned on.
- `193 <https://github.com/readthedocs/sphinx-autoapi/issues/193>` and
`208 <https://github.com/readthedocs/sphinx-autoapi/issues/208>`: (Python)
Inheritance diagrams can follow imports to find classes to document.
- `213 <https://github.com/readthedocs/sphinx-autoapi/issues/213>`: (Python)
Fixed module summary never showing.

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

- black shows diffs by default
- `207 <https://github.com/readthedocs/sphinx-autoapi/issues/207>`:
Fixed a typo in the code of the golang tutorial.

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

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

- Dropped support for Python 3.4 and 3.5.

Features
^^^^^^^^

- `151 <https://github.com/readthedocs/sphinx-autoapi/issues/151>`: (Python)
Added the ``autoapi_python_use_implicit_namespaces`` option to allow
AutoAPI to search for implicit namespace packages.
- Added support for Sphinx 2.2 and 2.3.
- Added support for Python 3.8.
- `140 <https://github.com/readthedocs/sphinx-autoapi/issues/140>`: (Python)
Added the ``autoapi-inheritance-diagram`` directive to create
inheritance diagrams without importing modules.
Enable the ``show-inheritance-diagram`` AutoAPI option to
turn the diagrams on in generated documentation.
- `183 <https://github.com/readthedocs/sphinx-autoapi/issues/183>`: (Python)
Added the ``show-inheritance`` AutoAPI option to be able to enable or disable
the display of a list of base classes in generated documentation about a class.
Added the ``inherited-members`` AutoAPI option to be able to enable or disable
the display of members inherited from a base class
in generated documentation about a class.
- The ``autoapi_include_summaries`` option has been replaced with the
``show-module-summary`` AutoAPI option.
``autoapi_include_summaries`` will stop working in the next major version.
- Added support for Sphinx 2.4 and 3.0

Bug Fixes
^^^^^^^^^

- `186 <https://github.com/readthedocs/sphinx-autoapi/issues/186>`: (Python)
Fixed an exception when there are too many argument type annotations
in a type comment.
- (Python) args and kwargs type annotations can be read from
the function type comment.

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

- Tests are now included in the sdist.

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

Bug Fixes
^^^^^^^^^

- (Python) "Invalid desc node" warning no longer raised for autodoc-style
directives.