Skip to content

Releases: readthedocs/sphinx-autoapi

v3.1.1

23 May 03:52
Compare
Choose a tag to compare

Bugfixes

  • Fix private subpackages causing orphan pages (#446)

v3.1.0

20 May 16:38
Compare
Choose a tag to compare

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

v3.1.0b0

12 Apr 16:55
Compare
Choose a tag to compare
v3.1.0b0 Pre-release
Pre-release

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 emitting ignore event twice for methods.

Misc

v3.1.0a4

24 Mar 22:24
Compare
Choose a tag to compare
v3.1.0a4 Pre-release
Pre-release

Features

  • Objects can render to their own page (#226)

Bugfixes

  • Children not present in __all__ are not rendered. (#226)
  • Fix emitting ignore event twice for methods. (#226)
  • Corrected documentation around imported-members to reflect that it
    applies only to objects imported into a package, not modules. (#226)
  • Fix path error on Windows. (#226)
  • Fix submodule with __init__.pyi documented as __init__ instead of submodule name (#398)
  • Fix IndexError when a module docstring contains only a heading (#412)

Misc

v3.1.0a3

16 Feb 22:25
Compare
Choose a tag to compare
v3.1.0a3 Pre-release
Pre-release

Bugfixes

  • Rename "single page output" to "own page output". (#226)

  • Also added tests for own page output. (#226)

  • Fix some inherited members always being rendered. (#226)

  • Own page members of an entity are linked to after the docstring of the parent entity. (#226)

  • Fix entities below the "class" level that have their own page from rendering incorrectly. (#226)

v3.1.0a2

16 Feb 21:22
Compare
Choose a tag to compare
v3.1.0a2 Pre-release
Pre-release

Bugfixes

  • Fix members inherited from Exception always being displayed (#226)

v3.1.0a1

01 Feb 04:11
Compare
Choose a tag to compare
v3.1.0a1 Pre-release
Pre-release

This is the first alpha release of version 3.1.0. This is being released as a pre-release version to allow users to test and give feedback about the changes relating to the new feature of allowing objects to render on their own page.

Features

  • Objects can render to their own page (#226)

Misc

v3.0.0

30 Sep 17:56
Compare
Choose a tag to compare

Bugfixes

  • Ensure tooltip is always a str
  • 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