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

build(deps): Bump sphinx-autoapi from 3.0.0 to 3.5.0 in /docs #917

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Feb 10, 2025

Bumps sphinx-autoapi from 3.0.0 to 3.5.0.

Release notes

Sourced from sphinx-autoapi's releases.

v3.5.0

Features

  • Can exclude directories from being documented (#312)

Bugfixes

  • Fix exception when calling a function imported from a wildcard (#508)
  • Remove usage of astroid alpha builds (#512)

Misc

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.

... (truncated)

Changelog

Sourced from sphinx-autoapi's changelog.

v3.5.0 (2025-02-09)

Features ^^^^^^^^

  • Can exclude directories from being documented (#312)

Bugfixes ^^^^^^^^

  • Fix exception when calling a function imported from a wildcard (#508)
  • Remove usage of astroid alpha builds (#512)

Misc ^^^^

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

... (truncated)

Commits
  • 26bd172 Version 3.5.0
  • 086dff8 Fixes for PR #503
  • b4c75f7 Allow skipping entire directories
  • a7a973d Make _need_to_load not assume that file ordering remained the same
  • 6fdc914 Fix inclusion of tests in the sdist
  • 156a2a7 Corrected license text in package metadata
  • 1c0a669 Fix exception when calling a function imported from a wildcard
  • d12eccb Fix formatting failure in tests
  • bc8f43b Add missing release notes entry for #512
  • 8f40ca9 Don't pull in alpha releases of astroid
  • 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 will merge this PR once CI passes on it, as requested by @TeoZosa.


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.5.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.5.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 dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Feb 10, 2025
Copy link
Owner

@TeoZosa TeoZosa left a comment

Choose a reason for hiding this comment

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

@dependabot merge

Copy link
Contributor Author

dependabot bot commented on behalf of github Feb 10, 2025

One of your CI runs failed on this pull request, so Dependabot won't merge it.

Dependabot will still automatically merge this pull request if you amend it and your tests pass.

Copy link
Contributor Author

dependabot bot commented on behalf of github Feb 18, 2025

Superseded by #923.

@dependabot dependabot bot closed this Feb 18, 2025
@dependabot dependabot bot deleted the dependabot/pip/docs/sphinx-autoapi-3.5.0 branch February 18, 2025 14:05
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