Skip to content
This repository has been archived by the owner on Sep 28, 2022. It is now read-only.

build(deps-dev): bump mkdocstrings from 0.18.1 to 0.19.0 #105

Merged
merged 1 commit into from
Jun 12, 2022

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github May 30, 2022

Bumps mkdocstrings from 0.18.1 to 0.19.0.

Release notes

Sourced from mkdocstrings's releases.

0.19.0

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

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](mkdocstrings/mkdocstrings#420)
  • Deprecate BaseCollector and BaseRenderer (eb822cb by Timothée Mazzucotelli). [PR #413](mkdocstrings/mkdocstrings#413)
Changelog

Sourced from mkdocstrings's changelog.

0.19.0 - 2022-05-28

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

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](mkdocstrings/mkdocstrings#420)
  • Deprecate BaseCollector and BaseRenderer (eb822cb by Timothée Mazzucotelli). [PR #413](mkdocstrings/mkdocstrings#413)
Commits
  • 5c0e4d1 chore: Prepare release 0.19.0
  • 0a9daf2 docs: Use installer instead of requests
  • 624e712 docs: Update docs
  • aa77b9c docs: Add logo
  • 7c71f26 refactor: Support options / deprecated options mix-up
  • c20022e refactor: Deprecate watch feature in favor of MkDocs' built-in one
  • 5d3250f chore: Template upgrade
  • 91f5f83 refactor: Log relative template paths if possible, instead of absolute
  • cccebc4 feat: Pass config file path to handlers
  • 3335310 refactor: Deprecate 'selection' and 'rendering' YAML keys
  • 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 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.18.1 to 0.19.0.
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/master/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.18.1...0.19.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 May 30, 2022
@sonarcloud
Copy link

sonarcloud bot commented May 30, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@codecov
Copy link

codecov bot commented May 30, 2022

Codecov Report

Merging #105 (1696eae) into main (bd8b2ec) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #105   +/-   ##
=======================================
  Coverage   29.70%   29.70%           
=======================================
  Files           9        9           
  Lines         643      643           
=======================================
  Hits          191      191           
  Misses        452      452           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bd8b2ec...1696eae. Read the comment docs.

@SG60 SG60 merged commit a98c60b into main Jun 12, 2022
@SG60 SG60 deleted the dependabot/pip/mkdocstrings-0.19.0 branch June 12, 2022 15:36
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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.

1 participant