Skip to content

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps sphinx-autoapi from 3.0.0 to 3.2.1.

Release notes

Sourced from sphinx-autoapi's releases.

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

v3.1.2

Bugfixes

  • Fix imported members being rendered in modules (#452)

v3.1.1

Bugfixes

  • Fix private subpackages causing orphan pages (#446)

v3.1.0

Features

  • Objects can render to their own page (#226)
  • Render PEP-695 type aliases as TypeAlias assignments. (#414)

Bugfixes

  • Values are always rendered for TypeAlises and PEP-695 type aliases. (#224)
  • Fix submodule with __init__.pyi documented as __init__ instead of submodule name (#398)
  • Fix IndexError when a module docstring contains only a heading (#412)
  • Preserve strings inside Literal type annotations (#423)

... (truncated)

Changelog

Sourced from sphinx-autoapi's changelog.

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 ^^^^^^^^^^^^^^^^^^^^^^^^^

  • 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 ^^^^

v3.1.2 (2024-06-20)

Bugfixes ^^^^^^^^

  • Fix imported members being rendered in modules (#452)

v3.1.1 (2024-05-22)

... (truncated)

Commits
  • 2a90c6d Version 3.2.1
  • 3e32238 Fix duplicates or error when init assigns to a property
  • a40327e Version 3.2.0
  • 746e00d Fixed formatting
  • acad72b Gracefully handle no objects being rendered
  • d2a9675 Fix srcdir usage as a string for compatibility with Sphinx v8
  • 52043a8 Address get_object_members() incompatibility with Sphinx v8
  • 83560ba Drop Python <=3.7 syntax
  • 1aade0f functools.cached_property is considered a property
  • fbacc72 Fix ignoring undocumented instance attributes
  • 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.2.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.2.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 Jul 29, 2024
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 2, 2024

Superseded by #80.

@dependabot dependabot bot closed this Sep 2, 2024
@dependabot dependabot bot deleted the dependabot/pip/sphinx-autoapi-3.2.1 branch September 2, 2024 12:49
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