Deprecations and Removals
^^^^^^^^^^^^^^^^^^^^^^^^^
Support for documenting languages other than Python is deprecated. (#248)
Removed the option to have autoapi generate toctree entries for domain objects.
Domain objects are now added to the toctree by Sphinx.
Dropped support for sphinx < 5.2.0. (#369)
Misc
^^^^
Added basic type checking.
Integrated towncrier into the release workflow.
v2.0.1 (2023-01-16)
Features
^^^^^^^^
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.
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)
Updates the requirements on sphinx-autoapi to permit the latest version.
Changelog
Sourced from sphinx-autoapi's changelog.
... (truncated)
Commits
47e5dcdVersion 2.1.0861b8e0Document towncrier in the README5fa927cDocument the deprecation for other languagesf440803Adjusted documentation around toctree editing6b16e02Let Sphinx handle adding domain directives to the toctree (#374)007d995Fix towncrier not finding default branch in CI58d653eAdded basic type checking1401facIntegrated towncrier into the release workflowDependabot 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)