Releases: readthedocs/sphinx-autoapi
Releases Β· readthedocs/sphinx-autoapi
v3.3.3
v3.3.2
v3.3.1
v3.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
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.