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

Bump sphinx-autoapi from 3.0.0 to 3.4.0 #1842

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps sphinx-autoapi from 3.0.0 to 3.4.0.

Release notes

Sourced from sphinx-autoapi's releases.

v3.4.0

Features

  • NamedTuples that have been created with functional syntax are documented as a class (#485)

Misc

v3.3.3

Bugfixes

  • Document packages and modules under a single "submodules" heading (#450)
  • Fix crash when __init__ is assigned to (#488)
  • Fix documenting incorrect attributes from __init__ (#497)

Misc

v3.3.2

Bugfixes

  • Fix types missing from documentation generated by autodoc-style directives. (#473)

v3.3.1

Bugfixes

  • Fix all class members missing when documenting a module with the same name as a standard library module. Members inherited from the standard library can also have their skip value overridden by autoapi-skip-member. (#478)

Misc

  • Updated all github actions.

v3.3.0

Features

  • Do not document members inherited from standard library classes (#467)

Bugfixes

  • Fix instance attributes not being documented by inherited-members (#477)

Misc

  • #425
  • Fix the parser returning a dictionary instead of a list in the empty parse scenario
  • Rename testenvs to all follow similar naming style

... (truncated)

Changelog

Sourced from sphinx-autoapi's changelog.

v3.4.0 (2024-11-29)

Features ^^^^^^^^

  • NamedTuples that have been created with functional syntax are documented as a class (#485)

Misc ^^^^

v3.3.3 (2024-10-25)

Bugfixes ^^^^^^^^

  • Document packages and modules under a single "submodules" heading (#450)
  • Fix crash when init is assigned to (#488)
  • Fix documenting incorrect attributes from init (#497)

Misc ^^^^

v3.3.2 (2024-09-25)

Bugfixes ^^^^^^^^

  • Fix types missing from documentation generated by autodoc-style directives. (#473)

v3.3.1 (2024-09-01)

Bugfixes ^^^^^^^^

  • Fix all class members missing when documenting a module with the same name as a standard library module

    Members inherited from the standard library can also have their skip value

... (truncated)

Commits
  • 9e6a70a Version 3.4.0
  • b3f768e NamedTuples are always documented as a class
  • 6f91543 Format Python code with ruff format instead of black (#498)
  • b2ff263 Keep GitHub Actions up to date with GitHub's Dependabot
  • 4e2d9ae Fix ruff compressions and performance issues (#490)
  • f5c7295 Version 3.3.3
  • eb2d7f2 Fix crash when init is assigned to
  • 0e9bb9b Document package and modules under a "submodules" heading
  • 53c2abc Attach release note to correct issue
  • 489abb1 Add missing release note
  • 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 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)

Bumps [sphinx-autoapi](https://github.com/readthedocs/sphinx-autoapi) from 3.0.0 to 3.4.0.
- [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.4.0)

---
updated-dependencies:
- dependency-name: sphinx-autoapi
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the pip dependencies pip dependencies from dependabot label Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pip dependencies pip dependencies from dependabot size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants