Skip to content

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps sphinx-autoapi from 3.0.0 to 3.3.1.

Release notes

Sourced from sphinx-autoapi's releases.

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

v3.2.1

Bugfixes

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

v3.2.0

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

  • Removed ability for autoapi_template_dir to be relative to cwd. This was supposed to have been retired in v3 (#457)
  • Removed autoapi_include_summaries option. This was supposed to have been retired in v3

Misc

... (truncated)

Changelog

Sourced from sphinx-autoapi's changelog.

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 overridden by autoapi-skip-member. (#478)

Misc ^^^^

  • Updated all github actions.

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)

... (truncated)

Commits
  • 841ce10 Version 3.3.1
  • 6877c81 Tests pass when ssl module is not included in the Python distribution
  • 367cd96 Update all github actions
  • 5d53f92 Fix all class members missing when documenting a module with the same name as...
  • 74770d3 Fix some typo and minor formatting issues in the docs
  • 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
  • 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.3.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.3.1)

---
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 Sep 2, 2024
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 30, 2024

Superseded by #82.

@dependabot dependabot bot closed this Sep 30, 2024
@dependabot dependabot bot deleted the dependabot/pip/sphinx-autoapi-3.3.1 branch September 30, 2024 12:46
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.

0 participants