ucl-bug / jwave

A JAX-based research framework for differentiable and parallelizable acoustic simulations, on CPU, GPUs and TPUs
GNU Lesser General Public License v3.0
135 stars 21 forks source link

build(deps-dev): update mkdocstrings requirement from ^0.22.0 to >=0.22,<0.24 #206

Closed dependabot[bot] closed 8 months ago

dependabot[bot] commented 1 year ago

Updates the requirements on mkdocstrings to permit the latest version.

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).

0.22.0 - 2023-05-25

Compare with 0.21.2

Features

Code Refactoring

  • Report inventory loading errors (2c05d78 by Timothée Mazzucotelli). Co-authored-by: Oleh Prypin oleh@pryp.in

0.21.2 - 2023-04-06

Compare with 0.21.1

Bug Fixes

0.21.1 - 2023-04-05

... (truncated)

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 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 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)
dependabot[bot] commented 8 months ago

Superseded by #230.