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 mkdocstrings from 0.22.0 to 0.24.0 #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 15, 2023

Bumps mkdocstrings from 0.22.0 to 0.24.0.

Release notes

Sourced from mkdocstrings's releases.

0.24.0

0.24.0 - 2023-11-14

Compare with 0.23.0

Features

Bug Fixes

Code Refactoring

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.24.0 - 2023-11-14

Compare with 0.23.0

Features

Bug Fixes

Code Refactoring

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
  • 032e417 chore: Prepare release 0.24.0
  • ce84dd5 feat: Cache downloaded inventories as local file
  • 4a97755 docs: Make recipe work with MkDocs -f option
  • b3edf89 ci: Some typing fixes/ignore
  • d74fada tests: Stop passing config file path to MkDocsConfig
  • 4dbb6d6 ci: Ruff auto-fix
  • 39694ac chore: Template upgrade
  • afc4ea4 fix: custom_templates config was dropped in previous commit (#630)
  • b61d4d1 refactor: Drop support for MkDocs < 1.4, modernize usages
  • 370a61d fix: Make custom_templates relative to the config file
  • 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 [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) from 0.22.0 to 0.24.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.24.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/main/mkdocstrings-0.24.0 branch from 52dfdf7 to 0a08737 Compare November 26, 2023 02:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog
Development

Successfully merging this pull request may close these issues.

4 participants