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.2.1 to 3.3.0 in the documentation-dependencies group #264

Closed

Conversation

dependabot[bot]
Copy link
Contributor

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

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

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
  • See full diff 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.3.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.2.1...v3.3.0)

---
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 Sep 1, 2024
@djperrefort djperrefort closed this Sep 3, 2024
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 3, 2024

This pull request was built based on a group rule. Closing it will not ignore any of these versions in future pull requests.

To ignore these dependencies, configure ignore rules in dependabot.yml

@dependabot dependabot bot deleted the dependabot/pip/documentation-dependencies-b233ace442 branch September 3, 2024 15:11
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