Skip to content

Update sphinx-autoapi requirement from <3.3,>=1.8 to >=1.8,<3.4#321

Merged
rmi-auto-merge-helper[bot] merged 1 commit intomainfrom
dependabot/pip/main/sphinx-autoapi-gte-1.8-and-lt-3.4
Aug 29, 2024
Merged

Update sphinx-autoapi requirement from <3.3,>=1.8 to >=1.8,<3.4#321
rmi-auto-merge-helper[bot] merged 1 commit intomainfrom
dependabot/pip/main/sphinx-autoapi-gte-1.8-and-lt-3.4

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 29, 2024

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

Release notes

Sourced from sphinx-autoapi's releases.

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
Changelog

Sourced from sphinx-autoapi's changelog.

v3.3.0 (2024-08-28)

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

v3.2.1 (2024-07-23)

Bugfixes ^^^^^^^^

  • Fix error or duplicates when init assigns to a property (#466)

v3.2.0 (2024-07-20)

Features ^^^^^^^^

  • functools.cached_property is considered a property (#436)

Bugfixes ^^^^^^^^

  • Gracefully handle no objects being rendered (#448)
  • Fix ignoring undocumented instance attributes (#451)

Deprecations and Removals ^^^^^^^^^^^^^^^^^^^^^^^^^

... (truncated)

Commits
  • 06780e3 Version 3.3.0
  • 1a0db7d Fix missing future import for Python 3.8
  • 1d1aa29 Fix instance attributes not being documented by inherited-members
  • eaac3e0 Fix the parser returning a dictionary instead of a list in the empty parse sc...
  • 2fa7515 Do not inherit docstrings from standard library classes
  • ce69512 Enable stricter type checks that require little to no code change
  • 00ee104 Perform stricter type checking on _astroid_utils
  • eee9d91 Rename testenvs to all follow similar naming style
  • 570a594 Do not document members inherited from stdlib classes
  • 2a90c6d Version 3.2.1
  • 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 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)

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Aug 29, 2024
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@v1.8.0...v3.3.0)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/main/sphinx-autoapi-gte-1.8-and-lt-3.4 branch from 1f50c10 to 92d3ab9 Compare August 29, 2024 12:33
@rmi-auto-merge-helper rmi-auto-merge-helper bot merged commit a330c77 into main Aug 29, 2024
@dependabot dependabot bot deleted the dependabot/pip/main/sphinx-autoapi-gte-1.8-and-lt-3.4 branch August 29, 2024 12:37
@coveralls
Copy link

coveralls commented Aug 29, 2024

Coverage Status

coverage: 89.737%. remained the same
when pulling 92d3ab9 on dependabot/pip/main/sphinx-autoapi-gte-1.8-and-lt-3.4
into def8985 on main.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant