Can turn off the addition of documented objects to the TOC tree.
Added support for Python 3.11.
Bug Fixes
^^^^^^^^^
[#330](https://github.com/readthedocs/sphinx-autoapi/issues/330) <https://github.com/readthedocs/sphinx-autoapi/issues/330>: (Python)
Render tuple values as tuples, not lists.
[#341](https://github.com/readthedocs/sphinx-autoapi/issues/341) <https://github.com/readthedocs/sphinx-autoapi/issues/341>: (Python)
Fix module level assignments to class attributes being documented as
module level attributes.
(Python) Fix "bysource" sort order showing items in alphabetical order.
(Python) Use the correct directives for a variable type and value.
Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
Removed some autogenerated test data from the repository.
v2.0.0 (2022-09-27)
Breaking Changes
^^^^^^^^^^^^^^^^
Dropped support for Sphinx <4.
[#352](https://github.com/readthedocs/sphinx-autoapi/issues/352) <https://github.com/readthedocs/sphinx-autoapi/issues/352>: (Python)
Properties are rendered with the property directive,
fixing support for Sphinx 5.2.
A new PythonPythonMapper object (PythonProperty) has been created
to support this change. This object can be passed to templates, filters,
and hooks.
A new property.rst template has also been created to support this change.
You can trigger a rebase of this PR 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)
Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.
Updates the requirements on sphinx-autoapi to permit the latest version.
Changelog
Sourced from sphinx-autoapi's changelog.
... (truncated)
Commits
2335e00Version 2.0.103aefdfFix more tests3849660Fix more tests3f8730aFix tests94b255aAdded support for Python 3.111556b17Use the correct directives for a variable type and value (#353)d732b49Don't force member sort order to alphabetic (#362)94295a4Don't document module level class attribute assignments0963c6dAdded missing changelog entry377a385Add option autoapi_add_objects_to_toctree (#284)You can trigger a rebase of this PR 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)