Skip to content

Bump mkdocstrings from 0.27.0 to 0.29.0 #429

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

Bump mkdocstrings from 0.27.0 to 0.29.0 #429

wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 10, 2025 •
edited by sourcery-ai bot
Loading

Bumps mkdocstrings from 0.27.0 to 0.29.0.

Release notes

Sourced from mkdocstrings's releases.

0.29.0

0.29.0 - 2025-03-10

Compare with 0.28.3

This is the last version before v1!

Build

  • Depend on MkDocs 1.6 (11bc400 by Timothée Mazzucotelli).

Features

Code Refactoring

  • Save and forward titles to autorefs (f49fb29 by Timothée Mazzucotelli).
  • Use a combined event (each split with a different priority) for on_env (8d1dd75 by Timothée Mazzucotelli).

0.28.3

0.28.3 - 2025-03-08

Compare with 0.28.2

Deprecations

All public objects must now be imported from the top-level mkdocstrings module. Importing from submodules is deprecated, and will raise errors starting with v1. This should be the last deprecation before v1.

Build

  • Make python extra depend on latest mkdocstrings-python (1.16.2) (ba9003e by Timothée Mazzucotelli).

Code Refactoring

  • Finish exposing/hiding public/internal objects (0723fc2 by Timothée Mazzucotelli).
  • Re-expose public API in the top-level mkdocstrings module (e66e080 by Timothée Mazzucotelli).
  • Move modules to internal folder (23fe23f by Timothée Mazzucotelli).

0.28.2

0.28.2 - 2025-02-24

Compare with 0.28.1

Build

  • Depend on mkdocs-autorefs >= 1.4 (2c22bdc by Timothée Mazzucotelli).

0.28.1

0.28.1 - 2025-02-14

... (truncated)

Changelog

Sourced from mkdocstrings's changelog.

0.29.0 - 2025-03-10

Compare with 0.28.3

This is the last version before v1!

Build

  • Depend on MkDocs 1.6 (11bc400 by Timothée Mazzucotelli).

Features

Code Refactoring

  • Save and forward titles to autorefs (f49fb29 by Timothée Mazzucotelli).
  • Use a combined event (each split with a different priority) for on_env (8d1dd75 by Timothée Mazzucotelli).

0.28.3 - 2025-03-08

Compare with 0.28.2

Deprecations

All public objects must now be imported from the top-level mkdocstrings module. Importing from submodules is deprecated, and will raise errors starting with v1. This should be the last deprecation before v1.

Build

  • Make python extra depend on latest mkdocstrings-python (1.16.2) (ba9003e by Timothée Mazzucotelli).

Code Refactoring

  • Finish exposing/hiding public/internal objects (0723fc2 by Timothée Mazzucotelli).
  • Re-expose public API in the top-level mkdocstrings module (e66e080 by Timothée Mazzucotelli).
  • Move modules to internal folder (23fe23f by Timothée Mazzucotelli).

0.28.2 - 2025-02-24

Compare with 0.28.1

Build

  • Depend on mkdocs-autorefs >= 1.4 (2c22bdc by Timothée Mazzucotelli).

0.28.1 - 2025-02-14

Compare with 0.28.0

Bug Fixes

... (truncated)

Commits
  • 32e415d chore: Prepare release 0.29.0
  • 44462d0 Merge branch 'main' of github.com:mkdocstrings/mkdocstrings
  • 3366f5b docs: Escape \<p> in docstrings
  • d4c7b9c feat: Support rendering backlinks through handlers
  • f49fb29 refactor: Save and forward titles to autorefs
  • 8d1dd75 refactor: Use a combined event (each split with a different priority) for `on...
  • 11bc400 build: Depend on MkDocs 1.6
  • fd28fff chore: Prepare release 0.28.3
  • 0723fc2 refactor: Finish exposing/hiding public/internal objects
  • 72e8bae docs: Simplify API docs
  • 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)

Summary by Sourcery

Bump mkdocstrings dependency from 0.27.0 to 0.29.0.

New Features:

  • Support rendering backlinks through handlers.

Build:

  • Depend on MkDocs 1.6.
  • Make python extra depend on latest mkdocstrings-python (1.16.2).
  • Depend on mkdocs-autorefs >= 1.4.

@dependabot
Bump mkdocstrings from 0.27.0 to 0.29.0
bf57783 
Bumps [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) from 0.27.0 to 0.29.0.
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.27.0...0.29.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 added dependencies Pull requests that update a dependency file python Pull requests that update python code labels Mar 10, 2025
@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Mar 10, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request bumps the mkdocstrings dependency from 0.27.0 to 0.29.0. The update includes new features like rendering backlinks, code refactoring for better organization, updated build dependencies, and deprecation of submodule imports.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Bumped the version of the mkdocstrings dependency.
  • Updated mkdocstrings from version 0.27.0 to 0.29.0.
 dev_requirements.txt
Add support for rendering backlinks through handlers.
  • Added the ability to render backlinks through handlers, enhancing navigation and context within the documentation.
Refactored code for better organization and functionality.
  • Saved and forwarded titles to autorefs for improved referencing.
  • Used a combined event with different priorities for on_env to streamline event handling.
  • Finished exposing/hiding public/internal objects to refine the API's visibility.
  • Re-exposed the public API in the top-level mkdocstrings module for easier access.
  • Moved modules to an internal folder to improve project structure.
Updated build dependencies.
  • Made the python extra depend on the latest mkdocstrings-python (1.16.2).
  • Depended on mkdocs-autorefs >= 1.4.
Addressed deprecations related to import paths.
  • Deprecated importing public objects from submodules, requiring import from the top-level mkdocstrings module.
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@dependabot dependabot bot mentioned this pull request Mar 10, 2025
Closed
sourcery-ai[bot]
sourcery-ai bot reviewed Mar 10, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have skipped reviewing this pull request. It seems to have been created by a bot (hey, dependabot[bot]!). We assume it knows what it's doing!

@dependabot Dependabot
Copy link
Contributor Author

dependabot bot commented on behalf of github Mar 31, 2025

Superseded by #434.

@dependabot dependabot bot closed this Mar 31, 2025
@dependabot dependabot bot deleted the dependabot/pip/mkdocstrings-0.29.0 branch March 31, 2025 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
dependencies Pull requests that update a dependency file python Pull requests that update python code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants