Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 29, 2023

Bumps sphinx-autoapi from 1.8.4 to 2.1.0.

Changelog

Sourced from sphinx-autoapi's changelog.

v2.1.0 (2023-03-28)

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.

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)

... (truncated)

Commits
  • 47e5dcd Version 2.1.0
  • 861b8e0 Document towncrier in the README
  • 5fa927c Document the deprecation for other languages
  • f440803 Adjusted documentation around toctree editing
  • 6b16e02 Let Sphinx handle adding domain directives to the toctree (#374)
  • 007d995 Fix towncrier not finding default branch in CI
  • 58d653e Added basic type checking
  • 1401fac Integrated towncrier into the release workflow
  • 2335e00 Version 2.0.1
  • 03aefdf Fix more tests
  • Additional commits viewable in compare view

Dependabot compatibility score

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](https://github.com/readthedocs/sphinx-autoapi) from 1.8.4 to 2.1.0.
- [Release notes](https://github.com/readthedocs/sphinx-autoapi/releases)
- [Changelog](https://github.com/readthedocs/sphinx-autoapi/blob/main/CHANGELOG.rst)
- [Commits](readthedocs/sphinx-autoapi@v1.8.4...v2.1.0)

---
updated-dependencies:
- dependency-name: sphinx-autoapi
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file python Pull requests that update Python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants