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

chore(deps-dev): bump mkdocstrings from 0.22.0 to 0.23.0 #225

Merged
merged 1 commit into from
Nov 7, 2023

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 1, 2023

Bumps mkdocstrings from 0.22.0 to 0.23.0.

Release notes

Sourced from mkdocstrings's releases.

0.23.0

0.23.0 - 2023-08-28

Compare with 0.22.0

Breaking Changes

  • Removed BaseCollector and BaseRenderer classes: they were merged into the BaseHandler class.
  • Removed the watch feature, as MkDocs now provides it natively.
  • Removed support for selection and rendering keys in YAML blocks: use options instead.
  • Removed support for loading handlers from the mkdocstrings.handler namespace. Handlers must now be packaged under the mkdocstrings_handlers namespace.

Features

  • Register all anchors for each object in the inventory (228fb73 by Timothée Mazzucotelli).

Bug Fixes

  • Don't add codehilite CSS class to inline code (7690d41 by Timothée Mazzucotelli).
  • Support cross-references for API docs rendered in top-level index page (b194452 by Timothée Mazzucotelli).

Code Refactoring

  • Sort inventories before writing them to disk (9371e9f by Timothée Mazzucotelli).
  • Stop accepting sets as return value of get_anchors (only tuples), to preserve order (2e10374 by Timothée Mazzucotelli).
  • Remove deprecated parts (0a90a47 by Timothée Mazzucotelli).
  • Use proper parameters in Inventory.register method (433c6e0 by Timothée Mazzucotelli).
Changelog

Sourced from mkdocstrings's changelog.

0.23.0 - 2023-08-28

Compare with 0.22.0

Breaking Changes

  • Removed BaseCollector and BaseRenderer classes: they were merged into the BaseHandler class.
  • Removed the watch feature, as MkDocs now provides it natively.
  • Removed support for selection and rendering keys in YAML blocks: use options instead.
  • Removed support for loading handlers from the mkdocstrings.handler namespace. Handlers must now be packaged under the mkdocstrings_handlers namespace.

Features

  • Register all anchors for each object in the inventory (228fb73 by Timothée Mazzucotelli).

Bug Fixes

  • Don't add codehilite CSS class to inline code (7690d41 by Timothée Mazzucotelli).
  • Support cross-references for API docs rendered in top-level index page (b194452 by Timothée Mazzucotelli).

Code Refactoring

  • Sort inventories before writing them to disk (9371e9f by Timothée Mazzucotelli).
  • Stop accepting sets as return value of get_anchors (only tuples), to preserve order (2e10374 by Timothée Mazzucotelli).
  • Remove deprecated parts (0a90a47 by Timothée Mazzucotelli).
  • Use proper parameters in Inventory.register method (433c6e0 by Timothée Mazzucotelli).
Commits
  • c071740 chore: Prepare release 0.23.0
  • 3ed3453 refactor: Don't sort inventories when reading them, it's useless
  • 9397460 refactor: Try calling deprecated get_anchor for a bit longer
  • fe8e3c5 docs: Enable auto-summaries
  • b89bb2d docs: Remove old contents
  • 9371e9f refactor: Sort inventories
  • 228fb73 feat: Register all anchors for each object in the inventory
  • 0b06d6a docs: Fix link (MkDocs 1.5)
  • 4396011 chore: Template upgrade
  • 7690d41 fix: Don't add codehilite CSS class to inline code
  • Additional commits viewable in compare view

Dependabot compatibility score

You can trigger a rebase of this PR 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)

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Oct 1, 2023
@codecov
Copy link

codecov bot commented Oct 1, 2023

Codecov Report

Merging #225 (e59821c) into main (781397a) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

❗ Current head e59821c differs from pull request most recent head 3720c3e. Consider uploading reports for the commit 3720c3e to get more accurate results

@@           Coverage Diff           @@
##             main     #225   +/-   ##
=======================================
  Coverage   98.38%   98.38%           
=======================================
  Files          19       19           
  Lines         744      744           
  Branches       90       90           
=======================================
  Hits          732      732           
  Misses         10       10           
  Partials        2        2           

@mcous
Copy link
Owner

mcous commented Nov 7, 2023

@dependabot rebase

@dependabot dependabot bot force-pushed the dependabot/pip/mkdocstrings-0.23.0 branch from e59821c to 10eebd4 Compare November 7, 2023 04:49
Bumps [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) from 0.22.0 to 0.23.0.
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.22.0...0.23.0)

---
updated-dependencies:
- dependency-name: mkdocstrings
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot force-pushed the dependabot/pip/mkdocstrings-0.23.0 branch from 10eebd4 to 3720c3e Compare November 7, 2023 04:49
@mcous mcous merged commit 93ff8f4 into main Nov 7, 2023
20 checks passed
@mcous mcous deleted the dependabot/pip/mkdocstrings-0.23.0 branch November 7, 2023 22:04
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.

None yet

1 participant