Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sphinx-autoapi requirement from <2.2,>=1.8 to >=1.8,<3.1 #123

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 27, 2023

Updates the requirements on sphinx-autoapi to permit the latest version.

Changelog

Sourced from sphinx-autoapi's changelog.

v3.0.0 (2023-09-26)

Bugfixes ^^^^^^^^

  • Ensure tooltip is always a str. (str-tooltip)
  • Replaced usage of deprecated sphinx.util.status_iterator (#391)

Deprecations and Removals ^^^^^^^^^^^^^^^^^^^^^^^^^

  • Removed support for documenting languages other than Python (#248)
  • Removed support for Python 3.7

Misc ^^^^

v2.1.1 (2023-06-10)

Bugfixes ^^^^^^^^

  • Fix "document isn't included" warning when using autoapi_add_toctree_entry (#319)
  • Types used in PEP-604 union syntax can be linked with intersphinx (#366)
  • Fix class overrides not rendering correctly.
  • Fix separated type comments for arguments not merging correctly in Python 3.7
  • Fixed viewcode being unable to find the source code for imported objects

Improved Documentation ^^^^^^^^^^^^^^^^^^^^^^

  • Made it clearer how to customise what objects AutoAPI will document. (#339)

Misc ^^^^

v2.1.0 (2023-03-28)

... (truncated)

Commits
  • 006142d Version 3.0.0
  • 6317148 Replace usage of deprecated astroid.NodeNG.doc in inheritance_diagrams.py
  • 4d1bec0 Removed support for Python 3.7
  • cf8abe5 Import fallback for older versions of Sphinx
  • 0186a3c Replace usage of deprecated sphinx.util.status_iterator
  • 92437c9 Removed old pylint pragmas
  • a22ae92 Removed support for documenting languages other than Python
  • 7b90b43 Add news
  • 4ea04f2 Ensure tooltip is always a str
  • 9d970a6 Rename master to main
  • Additional commits viewable in compare view

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 show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @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](https://github.com/readthedocs/sphinx-autoapi) to permit the latest version.
- [Changelog](https://github.com/readthedocs/sphinx-autoapi/blob/main/CHANGELOG.rst)
- [Commits](readthedocs/sphinx-autoapi@v1.8.0...v3.0.0)

---
updated-dependencies:
- dependency-name: sphinx-autoapi
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Sep 27, 2023
@bendnorman bendnorman merged commit 7e52468 into main Sep 27, 2023
6 checks passed
@bendnorman bendnorman deleted the dependabot/pip/main/sphinx-autoapi-gte-1.8-and-lt-3.1 branch September 27, 2023 10:03
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant