Sphinx-autoapi

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

Bugfixes
^^^^^^^^

- Ensure `tooltip` is always a `str`. (str-tooltip)
- Replaced usage of deprecated sphinx.util.status_iterator (391)


Deprecations and Removals
^^^^^^^^^^^^^^^^^^^^^^^^^

- Removed support for documenting languages other than Python (248)
- Removed support for Python 3.7


Misc
^^^^

- 389, 390, 392, 407

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

Bugfixes
^^^^^^^^

- Fix "document isn't included" warning when using autoapi_add_toctree_entry (319)
- Types used in PEP-604 union syntax can be linked with intersphinx (366)
- Fix class overrides not rendering correctly.
- Fix separated type comments for arguments not merging correctly in Python 3.7
- Fixed viewcode being unable to find the source code for imported objects


Improved Documentation
^^^^^^^^^^^^^^^^^^^^^^

- Made it clearer how to customise what objects AutoAPI will document. (339)


Misc
^^^^

- 375, 382

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

Deprecations and Removals
^^^^^^^^^^^^^^^^^^^^^^^^^

- Support for documenting languages other than Python is deprecated. (248)
- Removed the option to have autoapi generate toctree entries for domain objects.
Domain objects are now added to the toctree by Sphinx.
Dropped support for sphinx < 5.2.0. (369)


Misc
^^^^

- Added basic type checking.
- Integrated towncrier into the release workflow.

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

Features
^^^^^^^^
- Can turn off the addition of documented objects to the TOC tree.
- Added support for Python 3.11.

Bug Fixes
^^^^^^^^^
- `330 <https://github.com/readthedocs/sphinx-autoapi/issues/330>`: (Python)
Render tuple values as tuples, not lists.
- `341 <https://github.com/readthedocs/sphinx-autoapi/issues/341>`: (Python)
Fix module level assignments to class attributes being documented as
module level attributes.
- (Python) Fix "bysource" sort order showing items in alphabetical order.
- (Python) Use the correct directives for a variable type and value.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
- Removed some autogenerated test data from the repository.

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

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

- Dropped support for Sphinx <4.
- `352 <https://github.com/readthedocs/sphinx-autoapi/issues/352>`: (Python)
Properties are rendered with the ``property`` directive,
fixing support for Sphinx 5.2.
A new ``PythonPythonMapper`` object (``PythonProperty``) has been created
to support this change. This object can be passed to templates, filters,
and hooks.
A new ``property.rst`` template has also been created to support this change.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
- Use https links where possible in documentation.
- Pass correct argument types to ``status_iterator``.

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

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

- Dropped support for Python 3.6.

Features
^^^^^^^^

- Added support for Python 3.10.
- `222 <https://github.com/readthedocs/sphinx-autoapi/issues/222>`:
Marked extension as parallel read safe.

Bug Fixes
^^^^^^^^^
- `324 <https://github.com/readthedocs/sphinx-autoapi/issues/324>`: (Python)
Fail elegantly when no source files are found.
- (Python) Stop calling ``autodoc-process-docstring`` when docstring is empty.
Works around https://github.com/sphinx-doc/sphinx/issues/10701.
- `318 <https://github.com/readthedocs/sphinx-autoapi/issues/318>`: (Python)
Fixed misaligned argument types on methods/classmethods when using type comments.
- `278 <https://github.com/readthedocs/sphinx-autoapi/issues/278>`: (Python)
Limit signatures to 60 characters in summaries.
- Fix keyerror when using markdown sources.
- `328 <https://github.com/readthedocs/sphinx-autoapi/issues/328>`: (Python)
Fix kw-only marker getting ignored if first in the signature.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
- Fixed tests in Sphinx 5.
- Fixed many typos throughout the documentation.