Skip to content

[6.16.z] Bump sphinx-autoapi from 3.6.1 to 3.7.0#20782

Merged
github-actions[bot] merged 1 commit into6.16.zfrom
cherry-pick-6.16.z-486befb679a171d5deaf5dec16154becbb9cb7d2
Feb 12, 2026
Merged

[6.16.z] Bump sphinx-autoapi from 3.6.1 to 3.7.0#20782
github-actions[bot] merged 1 commit into6.16.zfrom
cherry-pick-6.16.z-486befb679a171d5deaf5dec16154becbb9cb7d2

Conversation

@Satellite-QE
Copy link
Collaborator

@Satellite-QE Satellite-QE commented Feb 12, 2026

Cherrypick of PR: #20777

Bumps sphinx-autoapi from 3.6.1 to 3.7.0.

Release notes

Sourced from sphinx-autoapi's releases.

v3.7.0

Features

  • Added autoapi.import warning for when AutoAPI directives are given non-existent objects
  • Adding autoapi_follow_symlinks, which allows api to traverse into symlinked directories when generating the API documentation.
  • Drop support for Python 3.9 and officially support Python 3.14
  • Support rendering PEP-695 type parameters

Bugfixes

  • Render typing_extensions.TypeAlias like other type aliases (#520)
  • Fix PythonFunction.overloads typing when source code overload(s) do not provide a return type (#523)

Misc

  • Fix deprecation warnings raised by astroid and sphinx
  • Handling case where match returns None to fix mypy unit test.
Changelog

Sourced from sphinx-autoapi's changelog.

v3.7.0 (2026-02-10)

Features ^^^^^^^^

  • Added autoapi.import warning for when AutoAPI directives are given non-existent objects
  • Adding autoapi_follow_symlinks, which allows api to traverse into symlinked directories when generating the API documentation.
  • Drop support for Python 3.9 and officially support Python 3.14
  • Support rendering PEP-695 type parameters

Bugfixes ^^^^^^^^

  • Render typing_extensions.TypeAlias like other type aliases (#520)
  • Fix PythonFunction.overloads typing when source code overload(s) do not provide a return type (#523)

Misc ^^^^

  • Fix deprecation warnings raised by astroid and sphinx
  • Handling case where match returns None to fix mypy unit test.
Commits
  • 0917ed2 Version 3.7.0
  • 394beb4 Add warning for missing import
  • 96cd74d Update changelog
  • c248b85 Render typing_extensions.TypeAlias like other type aliases
  • a2f49c9 Fix deprecation warnings raised by astroid and sphinx
  • 5ed0cd5 Update supported Python versions
  • 0f7b1ab Render type params by default
  • 42b315c fix: add missing release notes
  • 026acde fix: User may not have provided return annotation
  • cd62d87 [refactor]: match statement to ifs
  • 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 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)

Summary by Sourcery

Build:

  • Bump sphinx-autoapi from 3.6.1 to 3.7.0 in optional requirements to align with upstream tooling.

@Satellite-QE Satellite-QE added 6.16.z Auto_Cherry_Picked Automatically cherrypicked PR using GHA dependencies Pull requests that update a dependency file No-CherryPick PR doesnt need CherryPick to previous branches labels Feb 12, 2026
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 12, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the optional documentation dependency sphinx-autoapi from version 3.6.1 to 3.7.0 via a requirements file change, pulling in upstream feature and bugfix improvements for API docs generation.

File-Level Changes

Change Details Files
Upgrade sphinx-autoapi dependency to v3.7.0 for documentation generation.
  • Change the pinned sphinx-autoapi version from 3.6.1 to 3.7.0 in the optional requirements set used for docs tooling.
  • Align this branch with the upstream cherrypicked PR so Dependabot-managed doc dependencies are consistent across versions.
requirements-optional.txt

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions github-actions bot merged commit b455295 into 6.16.z Feb 12, 2026
17 checks passed
@github-actions github-actions bot deleted the cherry-pick-6.16.z-486befb679a171d5deaf5dec16154becbb9cb7d2 branch February 12, 2026 03:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.16.z Auto_Cherry_Picked Automatically cherrypicked PR using GHA dependencies Pull requests that update a dependency file No-CherryPick PR doesnt need CherryPick to previous branches

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant