Update sphinx-autoapi to 3.4.0

[pyup-bot]

This PR updates sphinx-autoapi from 1.3.0 to 3.4.0.

Changelog

3.3.3

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

Bugfixes
^^^^^^^^

- Document packages and modules under a single "submodules" heading (450)
- Fix crash when __init__ is assigned to (488)
- Fix documenting incorrect attributes from __init__ (497)


Misc
^^^^

- 426, 462, 491, 492

3.3.2

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

Bugfixes
^^^^^^^^

- Fix types missing from documentation generated by autodoc-style directives. (473)

3.3.1

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

Bugfixes
^^^^^^^^

- Fix all class members missing when documenting a module with the same name as a standard library module

Members inherited from the standard library can also have their skip value
overridden by autoapi-skip-member. (478)


Misc
^^^^

- Updated all github actions.

3.3.0

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

Features
^^^^^^^^

- Do not document members inherited from standard library classes. (467)


Bugfixes
^^^^^^^^

- Fix instance attributes not being documented by inherited-members (477)


Misc
^^^^

- 425
- Fix the parser returning a dictionary instead of a list in the empty parse scenario
- Rename testenvs to all follow similar naming style

3.2.1

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

Bugfixes
^^^^^^^^

- Fix error or duplicates when __init__ assigns to a property (466)

3.2.0

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

Features
^^^^^^^^

- functools.cached_property is considered a property (436)


Bugfixes
^^^^^^^^

- Gracefully handle no objects being rendered (448)
- Fix ignoring undocumented instance attributes (451)


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

- Removed ability for autoapi_template_dir to be relative to cwd. This was supposed to have been retired in v3 (457)
- Removed autoapi_include_summaries option. This was supposed to have been retired in v3


Misc
^^^^

- 428, 449

3.1.2

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

Bugfixes
^^^^^^^^

- Fix imported members being rendered in modules (452)

3.1.1

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

Bugfixes
^^^^^^^^

- Fix private subpackages causing orphan pages (446)

3.1.0

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

Features
^^^^^^^^

- Objects can render to their own page (226)
- Render PEP-695 type aliases as TypeAlias assignments. (414)


Bugfixes
^^^^^^^^

- Values are always rendered for TypeAlises and PEP-695 type aliases. (224)
- Fix submodule with `__init__.pyi` documented as `__init__` instead of submodule name (398)
- Fix IndexError when a module docstring contains only a heading (412)
- Preserve strings inside Literal type annotations (423)
- Stopped using xrefs in page titles (427)
- Fix unpickable configuration value warning when using autoapi_prepare_jinja_env (445)
- Fix emitting ignore event twice for methods.


Misc
^^^^

- 388

3.0.0

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

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

2.1.1

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

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

2.1.0

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

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.

2.0.1

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

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.

2.0.0

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

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``.

1.9.0

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

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.

1.8.4

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

Bug Fixes
^^^^^^^^^
- `301 <https://github.com/readthedocs/sphinx-autoapi/issues/301>`: (Python)
Fixed compatibility with astroid 2.7+.

1.8.3

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

Bug Fixes
^^^^^^^^^
- `299 <https://github.com/readthedocs/sphinx-autoapi/issues/299>`: (Python)
Fixed incorrect indentation in generated documentation when a class with no
constructor has a summary line spanning multiple lines.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
- Fixed broken link to Jinja objects.inv.

1.8.2

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

Bug Fixes
^^^^^^^^^

- Fixed error when parsing a class with no constructor.
- `293 <https://github.com/readthedocs/sphinx-autoapi/issues/293>`:
Fixed failure to build out of source conf.py files.
Configuration values using relative values are now relative to the source directory
instead of relative to the conf.py file.
- `289 <https://github.com/readthedocs/sphinx-autoapi/issues/289>`: (Python)
Fixed AttributeError using inheritance diagrams on a module with plain imports.
- `292 <https://github.com/readthedocs/sphinx-autoapi/issues/292>`:
Explicitly use the domain for generated directives.

1.8.1

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

Bug Fixes
^^^^^^^^^

- `273 <https://github.com/readthedocs/sphinx-autoapi/issues/273>`:
Fixed type annotations being shown for only a single module.

1.8.0

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

Features
^^^^^^^^

- Expandable value for multi-line string attributes.
- `265 <https://github.com/readthedocs/sphinx-autoapi/issues/265>`:
Can resolve the qualified paths of parameters to generics.
- `275 <https://github.com/readthedocs/sphinx-autoapi/issues/275>`:
Warnings have been categorised and can be suppressed through ``suppress_warnings``.
- `280 <https://github.com/readthedocs/sphinx-autoapi/issues/280>`:
Data attributes are documented in module summaries.

Bug Fixes
^^^^^^^^^

- `273 <https://github.com/readthedocs/sphinx-autoapi/issues/273>`:
Fixed setting ``autodoc_typehints`` to ``none`` or ``description``
not turning off signature type hints.
``autodoc_typehints`` integration is considered experimental until
the extension properly supports overload functions.
- `261 <https://github.com/readthedocs/sphinx-autoapi/issues/261>`:
Fixed data annotations causing pickle or deepcopy errors.
- Documentation can be generated when multiple source directories
share a single ``conf.py`` file.

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

- Fixed ``DeprecationWarning`` for invalid escape sequence ``\s`` in tests.
- Fixed ``FutureWarning`` for ``Node.traverse()`` becoming an iterator instead of list.
- New example implementation of ``autoapi-skip-member`` Sphinx event.
- Can run tests with tox 4.
- Updated packaging to use PEP-517.
- All unittest style tests have been converted to pytest style tests.
- An exception raised by docfx is raised directly instead of wrapping it.
- Started using Github Actions for continuous integration.

1.7.0

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

Features
^^^^^^^^

- The fully qualified path of objects are included type annotations
so that Sphinx can link to them.
- Added support for Sphinx 3.3. and 3.4.
- `240 <https://github.com/readthedocs/sphinx-autoapi/issues/240>`:
The docstrings of ``object.__init__``, ``object.__new__``,
``type.__init__``, and ``type.__new__`` are not inherited.

Bug Fixes
^^^^^^^^^

- `260 <https://github.com/readthedocs/sphinx-autoapi/issues/260>`:
The overload signatures of ``__init__`` methods are documented.

1.6.0

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

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.

1.5.1

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

Bug Fixes
^^^^^^^^^

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

1.5.0

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

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.

1.4.0

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

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.

Links

• PyPI: https://pypi.org/project/sphinx-autoapi
• Changelog: https://data.safetycli.com/changelogs/sphinx-autoapi/