Skip to content

Releases: readthedocs/sphinx-autoapi

v3.3.1

02 Sep 01:31
Compare
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
Compare
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

v3.2.1

23 Jul 17:12
Compare
Choose a tag to compare

Bugfixes

  • Fix error or duplicates definitions when __init__ assigns to a property (#466)

v3.2.0

20 Jul 17:50
Compare
Choose a tag to compare

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

v3.1.2

20 Jun 15:00
Compare
Choose a tag to compare

Bugfixes

  • Fix imported members being rendered in modules (#452)

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)