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.2.1 to 3.3.1 in the doc-dependencies group #99

Merged
merged 2 commits into from
Sep 4, 2024

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps the doc-dependencies group with 1 update: sphinx-autoapi.

Updates sphinx-autoapi from 3.2.1 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
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
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 <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

Bumps the doc-dependencies group with 1 update: [sphinx-autoapi](https://github.com/readthedocs/sphinx-autoapi).


Updates `sphinx-autoapi` from 3.2.1 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.2.1...v3.3.1)

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

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Sep 2, 2024
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 2, 2024

The following labels could not be found: maintenance.

Copy link

codecov bot commented Sep 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.71%. Comparing base (4202b96) to head (6d1b6c9).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #99   +/-   ##
=======================================
  Coverage   94.71%   94.71%           
=======================================
  Files           7        7           
  Lines         208      208           
=======================================
  Hits          197      197           
  Misses         11       11           

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

@fingeraugusto fingeraugusto merged commit a0e6454 into main Sep 4, 2024
23 checks passed
@fingeraugusto fingeraugusto deleted the dependabot/pip/doc-dependencies-b5c1c46cda branch September 4, 2024 20:14
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