Dropped support for Python 2 and Sphinx 1.x/2.x.
Python 2 source code can still be parsed.
Features
^^^^^^^^
Added support for using type hints as parameter types and return types
via the sphinx.ext.autodoc.typehints extension.
[#191](https://github.com/readthedocs/sphinx-autoapi/issues/191) <https://github.com/readthedocs/sphinx-autoapi/issues/191>:
Basic incremental build support is enabled autoapi_keep_files is enabled.
Providing none of the source files have changed,
AutoAPI will skip parsing the source code and regenerating the API documentation.
[#200](https://github.com/readthedocs/sphinx-autoapi/issues/200) <https://github.com/readthedocs/sphinx-autoapi/issues/200>:
Can pass a callback that edits the Jinja Environment object before
template rendering begins.
This allows custom filters, tests, and globals to be added to the environment.
Added support for Python 3.9.
Bug Fixes
^^^^^^^^^
[#246](https://github.com/readthedocs/sphinx-autoapi/issues/246) <https://github.com/readthedocs/sphinx-autoapi/issues/246>:
Fixed TypeError when parsing a class that inherits from type.
[#244](https://github.com/readthedocs/sphinx-autoapi/issues/244) <https://github.com/readthedocs/sphinx-autoapi/issues/244>:
Fixed an unnecessary deprecation warning being raised when running
sphinx-build from the same directory as conf.py.
Fixed properties documented by Autodoc directives geting documented as methods.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps sphinx-autoapi from 1.5.1 to 1.6.0.
Changelog
Sourced from sphinx-autoapi's changelog.
Commits
731323cVersion 1.6.0714c060Added Python 3.9 supporta8d07b6Can edit the Jinja environment06a1969Fixed autodoc directives documenting properties as methodse281137Fixed raising unnecessary deprecation warning78b7958Implmented basic incremental building6a6f7a9Added CHANGELOG entry5ee7dbeCorrectly parse Metaclasses7330297Fixed tests on Python <3.831d4bebReadthedocs uses Python 3.8Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)