Releases: readthedocs/sphinx-autoapi
Releases · readthedocs/sphinx-autoapi
v3.2.1
v3.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
v3.1.2
v3.1.1
v3.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
v3.1.0b0
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
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
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)