Releases: readthedocs/sphinx-autoapi
Releases Β· readthedocs/sphinx-autoapi
v3.5.0
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
Features
- NamedTuples that have been created with functional syntax are documented as a class (#485)
Misc
v3.3.3
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
Bugfixes
- Fix types missing from documentation generated by autodoc-style directives. (#473)
v3.3.1
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
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
Bugfixes
- Fix error or duplicates definitions when
__init__
assigns to a property (#466)
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
Bugfixes
- Fix imported members being rendered in modules (#452)
v3.1.1
Bugfixes
- Fix private subpackages causing orphan pages (#446)