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 <3,>=2.1.1 to >=2.1.1,<4 #4667

Closed

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 3, 2023

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

Release notes

Sourced from sphinx-autoapi's releases.

v3.0.0

Bugfixes

  • Ensure tooltip is always a str
  • 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

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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Nov 3, 2023
@dependabot dependabot bot force-pushed the dependabot/pip/sphinx-autoapi-gte-2.1.1-and-lt-4 branch 2 times, most recently from 43bee1c to bde25c1 Compare November 8, 2023 20:01
Updates the requirements on [sphinx-autoapi](https://github.com/readthedocs/sphinx-autoapi) to permit the latest version.
- [Release notes](https://github.com/readthedocs/sphinx-autoapi/releases)
- [Changelog](https://github.com/readthedocs/sphinx-autoapi/blob/main/CHANGELOG.rst)
- [Commits](readthedocs/sphinx-autoapi@v2.1.1...v3.0.0)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/pip/sphinx-autoapi-gte-2.1.1-and-lt-4 branch from bde25c1 to 5ba21b7 Compare November 9, 2023 15:33
Copy link
Contributor Author

dependabot bot commented on behalf of github Nov 13, 2023

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@DailyDreaming DailyDreaming deleted the dependabot/pip/sphinx-autoapi-gte-2.1.1-and-lt-4 branch November 13, 2023 17:37
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.

1 participant