Skip to content

Update sphinx-autoapi requirement from >=3.8.0 to >=3.8.1 in /doc - #1044

Merged
Sergiy Matusevych (motus) merged 3 commits into
mainfrom
dependabot/pip/doc/sphinx-autoapi-gte-3.8.1
Oct 14, 2026
Merged

Sergiy Matusevych (motus) merged 3 commits into
mainfrom
dependabot/pip/doc/sphinx-autoapi-gte-3.8.1

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Oct 14, 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.8.1

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
Changelog

Sourced from sphinx-autoapi's changelog.

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 ^^^^^^^^

  • Autodoc-style directives can access members excluded by autoapi_options

Misc ^^^^

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

... (truncated)

Commits
  • 7018ce6 Version 3.8.1
  • 9079d5b Fix ellipsis rendering in type annotations
  • f37bd4b Fix towncrier check failing in CI
  • 6df6d61 Bump the github-actions group with 2 updates
  • b76b462 Fix linting errors
  • 2b7d443 Fix use of class-scoped fixture as instance method
  • 2b8bb52 Bump the github-actions group with 2 updates
  • 2088028 Switch to tox.toml and reorganise repo structure
  • eca0b11 Document autoapisummary directive
  • 74ed53e Bump sigstore/gh-action-sigstore-python in the github-actions group
  • See full diff in compare view

@dependabot
dependabot Bot requested a review from a team as a code owner October 14, 2026 00:30
Copilot AI balanced review requested due to automatic review settings October 14, 2026 00:30
@dependabot dependabot Bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Oct 14, 2026

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

The focused dependency patch update is valid and matches the stated purpose.

0 open findings

What changed in this PR

Updates the documentation dependency minimum to sphinx-autoapi 3.8.1, incorporating its annotation-rendering bugfix.

Changes:

  • Raises sphinx-autoapi’s minimum version from 3.8.0 to 3.8.1.
File Description
doc/​requirements.txt Updates the sphinx-autoapi version constraint.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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.0...v3.8.1)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
dependabot Bot force-pushed the dependabot/pip/doc/sphinx-autoapi-gte-3.8.1 branch from bb5a65a to 84c896a Compare October 14, 2026 00:57
@motus
Sergiy Matusevych (motus) merged commit 442d034 into main Oct 14, 2026
17 checks passed
@motus
Sergiy Matusevych (motus) deleted the dependabot/pip/doc/sphinx-autoapi-gte-3.8.1 branch October 14, 2026 02:23
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.

2 participants