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

Bump sphinx-autoapi from 3.0.0 to 3.1.0 #592

Merged
merged 1 commit into from
May 22, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github May 22, 2024

Bumps sphinx-autoapi from 3.0.0 to 3.1.0.

Release notes

Sourced from sphinx-autoapi's releases.

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)
  • Stopped using xrefs in page titles (#427)
  • Fix unpickable configuration value warning when using autoapi_prepare_jinja_env (#445)
  • Fix emitting ignore event twice for methods.

Misc

v3.1.0b0

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)
  • Stopped using xrefs in page titles (#427)
  • Fix emitting ignore event twice for methods.

Misc

v3.1.0a4

Features

  • Objects can render to their own page (#226)

Bugfixes

  • Children not present in __all__ are not rendered. (#226)

... (truncated)

Changelog

Sourced from sphinx-autoapi's changelog.

v3.1.0 (2024-05-20)

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)
  • Stopped using xrefs in page titles (#427)
  • Fix unpickable configuration value warning when using autoapi_prepare_jinja_env (#445)
  • Fix emitting ignore event twice for methods.

Misc ^^^^

Commits
  • bf2ff28 Version 3.1.0
  • 4ff4116 Fix unpickable configuration value when using autoapi_prepare_jinja_env
  • f23b079 Stop using xrefs in page titles
  • 3b037c7 Moved bugfix announcement into a separate news item
  • bc71226 Render PEP-695 type aliases as TypeAlias assignments
  • 007077a Refactor mapper classes into their bases
  • a6558dc Various fixes for own page output
  • 2a603b8 Recursive rendering of children with their own page
  • 93fb571 Basic tests for single page rendering
  • ecd47ea Initial implementation of customisable single page output
  • 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)

updated-dependencies:
- dependency-name: sphinx-autoapi
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels May 22, 2024
Copy link

codecov bot commented May 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.1%. Comparing base (aed2615) to head (2e2e8b4).
Report is 259 commits behind head on master.

Additional details and impacted files
@@          Coverage Diff           @@
##           master    #592   +/-   ##
======================================
  Coverage    98.1%   98.1%           
======================================
  Files         162     162           
  Lines        3108    3108           
  Branches      760     760           
======================================
  Hits         3050    3050           
  Misses         37      37           
  Partials       21      21           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@vprusso vprusso merged commit edf8d2b into master May 22, 2024
18 checks passed
@vprusso vprusso deleted the dependabot/pip/sphinx-autoapi-3.1.0 branch May 22, 2024 09:59
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