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.0.0 to 3.1.1 in the documentation-dependencies group #238

Merged
merged 2 commits into from
Jun 13, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jun 1, 2024

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

Release notes

Sourced from sphinx-autoapi's releases.

v3.1.1

Bugfixes

  • Fix private subpackages causing orphan pages (#446)
Changelog

Sourced from sphinx-autoapi's changelog.

v3.1.1 (2024-05-22)

Bugfixes ^^^^^^^^

  • Fix private subpackages causing orphan pages (#446)

v3.1.0 (2024-05-20)

Features ^^^^^^^^

  • Objects can render to their own page (#226)
  • Render PEP-695 type aliases as TypeAlias assignments. (#414)

Bugfixes ^^^^^^^^

  • Values are always rendered for TypeAlises and PEP-695 type aliases. (#224)
  • Fix submodule with __init__.pyi documented as __init__ instead of submodule name (#398)
  • Fix IndexError when a module docstring contains only a heading (#412)
  • Preserve strings inside Literal type annotations (#423)
  • Stopped using xrefs in page titles (#427)
  • Fix unpickable configuration value warning when using autoapi_prepare_jinja_env (#445)
  • Fix emitting ignore event twice for methods.

Misc ^^^^

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

... (truncated)

Commits
  • 8001fbd Version 3.1.1
  • eecb6e8 Fix private subpackages causing orphan pages
  • d45f2ed Start testing in Python 3.13
  • 7b10bb2 Fix distribution signing failing due to importerror
  • bf2ff28 Version 3.1.0
  • 4ff4116 Fix unpickable configuration value when using autoapi_prepare_jinja_env
  • f23b079 Stop using xrefs in page titles
  • 3b037c7 Moved bugfix announcement into a separate news item
  • bc71226 Render PEP-695 type aliases as TypeAlias assignments
  • 007077a Refactor mapper classes into their bases
  • 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 <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
  • @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
  • @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
  • @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
  • @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

Updates the requirements on [sphinx-autoapi](https://github.com/readthedocs/sphinx-autoapi) to permit the latest version.

Updates `sphinx-autoapi` to 3.1.1
- [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.0.0...v3.1.1)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Jun 1, 2024
@Comeani Comeani merged commit d08a662 into main Jun 13, 2024
11 checks passed
@Comeani Comeani deleted the dependabot/pip/documentation-dependencies-47543b79e7 branch June 13, 2024 20:20
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