Skip to content

Releases: readthedocs/sphinx-autoapi

v3.8.0

08 Mar 03:49

Choose a tag to compare

Features

  • Autodoc-style directives can access members excluded by autoapi_options

Misc

v3.7.0

11 Feb 05:23

Choose a tag to compare

Features

  • Added autoapi.import warning for when AutoAPI directives are given non-existent objects
  • Adding autoapi_follow_symlinks, which allows api to traverse into symlinked directories when generating the API documentation.
  • Drop support for Python 3.9 and officially support Python 3.14
  • Support rendering PEP-695 type parameters

Bugfixes

  • Render typing_extensions.TypeAlias like other type aliases (#520)
  • Fix PythonFunction.overloads typing when source code overload(s) do not provide a return type (#523)

Misc

  • Fix deprecation warnings raised by astroid and sphinx
  • Handling case where match returns None to fix mypy unit test.

v3.6.1

06 Oct 16:20

Choose a tag to compare

Bugfixes

  • Update the supported versions of astroid. Fix the breaking change to Import and pass in the AstroidManager to the AstroidBuilder (#536)

v3.6.0

18 Feb 01:50

Choose a tag to compare

Features

  • Render type aliases properly rather than as an assignment (#414)

Misc

  • Drop support for Python 3.8
  • Fix readthedocs build

v3.5.0

10 Feb 04:22

Choose a tag to compare

Features

  • Can exclude directories from being documented (#312)

Bugfixes

  • Fix exception when calling a function imported from a wildcard (#508)
  • Remove usage of astroid alpha builds (#512)

Misc

v3.4.0

30 Nov 01:08

Choose a tag to compare

Features

  • NamedTuples that have been created with functional syntax are documented as a class (#485)

Misc

v3.3.3

26 Oct 00:45

Choose a tag to compare

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

v3.3.2

25 Sep 23:55

Choose a tag to compare

Bugfixes

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

v3.3.1

02 Sep 01:31

Choose a tag to compare

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.

v3.3.0

29 Aug 04:41

Choose a tag to compare

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