镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

Update sphinx-autoapi requirement from >=3.8.1 to >=3.9.0 in /doc - #1059

Open
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/pip/doc/sphinx-autoapi-gte-3.9.0
Open

dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/pip/doc/sphinx-autoapi-gte-3.9.0

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Nov 3, 2026

Copy link
Copy Markdown
Contributor

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

Release notes

Sourced from sphinx-autoapi's releases.

v3.9.0

Features

  • Detect source file changes based on content hashing instead of modification time to support caching in CI environments. (#573)

Bugfixes

  • Stop documenting code under if __name__ == "__main__". Only its first definition used to show up, now none of it does, as with autodoc. (#429)
  • Fix autoapisummary showing only the return annotation of a function, in place of its arguments. (#531)
  • Create directory symlinks used by the test suite at runtime so tests pass from source distributions. (#565)
  • Fix infinite recursion when a nested class inherits from its enclosing class. (#571)

Improved Documentation

  • Update the landing page grid layout so that the cards stack on narrow screens (#575)
Changelog

Sourced from sphinx-autoapi's changelog.

v3.9.0 (2026-10-30)

Features ^^^^^^^^

  • Detect source file changes based on content hashing instead of modification time to support caching in CI environments. (#573)

Bugfixes ^^^^^^^^

  • Stop documenting code under if __name__ == "__main__":. Only its first definition used to show up, now none of it does, as with autodoc. (#429)
  • Fix autoapisummary showing only the return annotation of a function, in place of its arguments. (#531)
  • Create directory symlinks used by the test suite at runtime so tests pass from source distributions. (#565)
  • Fix infinite recursion when a nested class inherits from its enclosing class. (#571)

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

  • Update the landing page grid layout so that the cards stack on narrow screens (#575)

v3.8.1 (2026-08-23)

Bugfixes ^^^^^^^^

  • Preserve ellipsis literals when rendering type annotations. (#562)

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

  • Document the autoapisummary directive. (#377)

Misc ^^^^

  • #564
  • Switch to tox.toml and reorganise repo structure

v3.8.0 (2026-03-07)

Features

... (truncated)

Commits
  • 1b21959 Version 3.9.0
  • 3756c4e Stop documenting code under an if name == "main" block
  • 55625d6 docs: update changelog description
  • c50ce50 feat: make content hashing the default behaviour
  • 4c82e70 feat: add option for setting how file changes are detected
  • 83d1205 Fix recursion when a nested class inherits from its enclosing class
  • 667c8df Add test for nested class inheriting from its enclosing class
  • efe4b59 Fix autoapisummary signatures of functions with a return annotation
  • e8fd0f8 Add release note for grid layout update
  • cd91429 Update grid layout from 2 to 1 2 2 2
  • 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 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.
- [Release notes](https://github.com/readthedocs/sphinx-autoapi/releases)
- [Changelog](https://github.com/readthedocs/sphinx-autoapi/blob/main/CHANGELOG.rst)
- [Commits](readthedocs/sphinx-autoapi@v3.8.1...v3.9.0)

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

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 Nov 3, 2026
@dependabot
dependabot Bot requested a review from a team as a code owner November 3, 2026 17:12
Copilot AI balanced review requested due to automatic review settings November 3, 2026 17:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

There are no active review issues for the Sphinx AutoAPI minimum-version update.

No open issues 🎉

What changed in this PR

Updates the documentation build dependencies to require Sphinx AutoAPI 3.9.0 or newer.

Changes:

  • Raises the sphinx-autoapi minimum version from 3.8.1 to 3.9.0, incorporating upstream content-hash change detection and API documentation fixes.
File Description
doc/​requirements.txt Raises the minimum Sphinx AutoAPI version for documentation builds.

Review effort: Balanced

This branch has not been deployed

No deployments
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