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.

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

chore(deps): update dependency mkdocstrings to ^0.25.0 #355

Closed
wants to merge 1 commit into from
Closed

chore(deps): update dependency mkdocstrings to ^0.25.0 #355

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Apr 28, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mkdocstrings (changelog) ^0.15.0 -> ^0.25.0 age adoption passing confidence

Release Notes

mkdocstrings/mkdocstrings (mkdocstrings)

v0.25.0

Compare Source

Compare with 0.24.3

Features
  • Support once parameter in logging methods, allowing to log a message only once with a given logger (1532b59 by Timothée Mazzucotelli).
  • Support blank line between ::: path and YAML options (d799d2f by Timothée Mazzucotelli). Issue-450
Code Refactoring
  • Allow specifying name of template loggers (c5b5f69 by Timothée Mazzucotelli).

v0.24.3

Compare Source

Compare with 0.24.2

Bug Fixes
  • Support HTML toc labels with Python-Markdown 3.6+ (uncomment code...) (7fe3e5f by Timothée Mazzucotelli).

v0.24.2

Compare Source

Compare with 0.24.1

Bug Fixes

v0.24.1

Compare Source

Compare with 0.24.0

Code Refactoring

v0.24.0

Compare Source

Compare with 0.23.0

Features
Bug Fixes
Code Refactoring
  • Drop support for MkDocs < 1.4, modernize usages (b61d4d1 by Oleh Prypin). PR #​629

v0.23.0

Compare Source

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

v0.22.0

Compare Source

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

v0.21.2

Compare Source

Compare with 0.21.1

Bug Fixes

v0.21.1

Compare Source

Compare with 0.21.0

Bug Fixes
  • Fix missing typing-extensions dependency on Python less than 3.10 (bff760b by Timothée Mazzucotelli). Issue #​548

v0.21.0

Compare Source

Compare with 0.20.0

Features

v0.20.0

Compare Source

Compare with 0.19.1

Features
Bug Fixes
Code Refactoring

v0.19.1

Compare Source

Compare with 0.19.0

Bug Fixes
Code Refactoring

v0.19.0

Compare Source

Compare with 0.18.1

Highlights

We decided to deprecate a few things to pave the way towards a more
stable code base, bringing us closer to a v1.

  • Selection and rendering options are now combined into a single
    options key. Using the old keys will emit a deprecation warning.
  • The BaseCollector and BaseRenderer classes are deprecated in favor
    of BaseHandler, which merges their functionality. Using the old
    classes will emit a deprecation warning.

New versions of the Python handler and the legacy Python handler
were also released in coordination with mkdocstrings 0.19.
See their respective changelogs:
python,
python-legacy.
Most notably, the Python handler gained the members and filters options
that prevented many users to switch to it.

mkdocstrings stopped depending directly on the legacy Python handler.
It means you now have to explicitely depend on it, directly or through
the extra provided by mkdocstrings, if you want to continue using it.

Packaging / Dependencies
  • Stop depending directly on mkdocstrings-python-legacy (9055d58 by Timothée Mazzucotelli). Issue #​376
Features
Code Refactoring
  • Support options / deprecated options mix-up (7c71f26 by Timothée Mazzucotelli).
  • Deprecate watch feature in favor of MkDocs' built-in one (c20022e by Timothée Mazzucotelli).
  • Log relative template paths if possible, instead of absolute (91f5f83 by Timothée Mazzucotelli).
  • Deprecate selection and rendering YAML keys (3335310 by Timothée Mazzucotelli). PR #​420
  • Deprecate BaseCollector and BaseRenderer (eb822cb by Timothée Mazzucotelli). PR #​413

v0.18.1

Compare Source

Compare with 0.18.0

Bug Fixes
  • Don't preemptively register identifiers as anchors (c7ac043 by Timothée Mazzucotelli).

v0.18.0

Compare Source

Compare with 0.17.0

Highlights
Packaging / Dependencies
  • Add Crystal extra, update Python extras versions (b8222b0 by Timothée Mazzucotelli). PR #​374
  • Update autorefs to actually required version (fc6c7f6 by Timothée Mazzucotelli).
  • Drop Python 3.6 support (7205ac6 by Timothée Mazzucotelli).
Features
  • Allow unwrapping the <p> tag in convert_markdown filter (5351fc8 by Oleh Prypin). PR #​369
  • Support handlers spanning multiple locations (f42dfc6 by Timothée Mazzucotelli). PR #​355
Code Refactoring

v0.17.0

Compare Source

Compare with 0.16.2

Features
Bug Fixes
Code Refactoring

v0.16.2

Compare Source

Compare with 0.16.1

Dependencies
  • Support pymdown-extensions v9.x (0831343 by Ofek Lev and 38b22ec by Timothée Mazzucotelli).

v0.16.1

Compare Source

Compare with 0.16.0

Bug Fixes
  • Fix ReadTheDocs "return" template (598621b by Timothée Mazzucotelli).

v0.16.0

Compare Source

Compare with 0.15.0

Features
Bug Fixes
Code Refactoring
  • Move writing extra files to an earlier stage in the build (3890ab5 by Oleh Prypin). PR #​275

Configuration

📅 Schedule: Branch creation - "before 4am" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from billsioros as a code owner April 28, 2024 01:27
@renovate renovate bot added the 🎲 dependencies Working on dependencies label Apr 28, 2024
@renovate Renovate
Copy link
Author

renovate bot commented Apr 28, 2024

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: poetry.lock
Creating virtualenv dotify-goMkGsqJ-py3.12 in /home/ubuntu/.cache/pypoetry/virtualenvs
Updating dependencies
Resolving dependencies...


The current project's Python requirement (>=3.7,<4.0) is not compatible with some of the required packages Python requirement:
  - mkdocstrings requires Python >=3.8, so it will not be satisfied for Python >=3.7,<3.8

Because mkdocstrings (0.25.0) requires Python >=3.8
 and no versions of mkdocstrings match >0.25.0,<0.26.0, mkdocstrings is forbidden.
So, because dotify depends on mkdocstrings (^0.25.0), version solving failed.

  • Check your dependencies Python requirement: The Python requirement can be specified via the `python` or `markers` properties
    
    For mkdocstrings, a possible solution would be to set the `python` property to ">=3.8,<4.0"

    https://python-poetry.org/docs/dependency-specification/#python-restricted-dependencies,
    https://python-poetry.org/docs/dependency-specification/#using-environment-markers

@stale Stale
Copy link

stale bot commented May 5, 2024

This issue has been marked stale, as it had no activity in the last 7 days. If the issue remains stale for an additional 7 days (a total of two weeks with no activity), it will be automatically closed.

@stale stale bot added the 💀 stale This had no recent activity label May 5, 2024
@stale Stale
Copy link

stale bot commented May 14, 2024

Closing the issue due to inactivity.

@stale stale bot closed this May 14, 2024
@renovate Renovate
Copy link
Author

renovate bot commented May 14, 2024

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update (^0.25.0). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the ignoreDeps array of your Renovate config.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.

@renovate renovate bot deleted the renovate/mkdocstrings-0.x branch May 14, 2024 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@billsioros billsioros Awaiting requested review from billsioros billsioros is a code owner

Assignees

@billsioros billsioros

Labels
🎲 dependencies Working on dependencies 💀 stale This had no recent activity
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@billsioros