Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Bump mkdocstrings from 0.18.1 to 0.19.0 #314

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
Merged
merged 1 commit into from
Jun 2, 2022
Merged

Bump mkdocstrings from 0.18.1 to 0.19.0 #314

merged 1 commit into from
Jun 2, 2022

Conversation

@dependabot
Copy link
Contributor

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

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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels May 30, 2022
@codecov
Copy link

codecov bot commented May 30, 2022 •
edited
Loading

Codecov Report

Merging #314 (112b80a) into main (1b8c48a) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #314   +/-   ##
=======================================
  Coverage   98.48%   98.48%           
=======================================
  Files          10       10           
  Lines        1243     1243           
=======================================
  Hits         1224     1224           
  Misses         19       19

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 1b8c48a...112b80a. Read the comment docs.

@dependabot dependabot bot force-pushed the dependabot/pip/mkdocstrings-0.19.0 branch from 8f878e3 to fc5db11 Compare June 2, 2022 04:27
@Anselmoo
Copy link
Owner

Anselmoo commented Jun 2, 2022

@dependabot rebase

@dependabot
Bump mkdocstrings from 0.18.1 to 0.19.0
112b80a 
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] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/pip/mkdocstrings-0.19.0 branch from fc5db11 to 112b80a Compare June 2, 2022 04:48
@Anselmoo Anselmoo merged commit 6b4389e into main Jun 2, 2022
@Anselmoo Anselmoo deleted the dependabot/pip/mkdocstrings-0.19.0 branch June 2, 2022 10:43
Anselmoo added a commit that referenced this pull request Jun 2, 2022
@Anselmoo
Squashed commit of the following:
2593b30 
commit 6b4389e
Merge: 1b8c48a 112b80a
Author: Anselm Hahn <[email protected]>
Date:   Thu Jun 2 12:43:19 2022 +0200

    Merge pull request #314 from Anselmoo/dependabot/pip/mkdocstrings-0.19.0

    Bump mkdocstrings from 0.18.1 to 0.19.0

commit 112b80a
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Thu Jun 2 04:48:18 2022 +0000

    Bump mkdocstrings from 0.18.1 to 0.19.0

    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] <[email protected]>

commit 1b8c48a
Merge: 2f91e04 36fbfb1
Author: Anselm Hahn <[email protected]>
Date:   Thu Jun 2 06:40:20 2022 +0200

    Merge pull request #315 from Anselmoo/pre-commit-ci-update-config

    [pre-commit.ci] pre-commit autoupdate

commit 2f91e04
Merge: f04b437 0ef35e7
Author: Anselm Hahn <[email protected]>
Date:   Thu Jun 2 06:19:26 2022 +0200

    Merge pull request #316 from Anselmoo/dependabot/pip/types-pyyaml-6.0.8

    Bump types-pyyaml from 6.0.7 to 6.0.8

commit 0ef35e7
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Thu Jun 2 00:35:50 2022 +0000

    Bump types-pyyaml from 6.0.7 to 6.0.8

    Bumps [types-pyyaml](https://github.com/python/typeshed) from 6.0.7 to 6.0.8.
    - [Release notes](https://github.com/python/typeshed/releases)
    - [Commits](https://github.com/python/typeshed/commits)

    ---
    updated-dependencies:
    - dependency-name: types-pyyaml
      dependency-type: direct:development
      update-type: version-update:semver-patch
    ...

    Signed-off-by: dependabot[bot] <[email protected]>

commit 36fbfb1
Author: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date:   Mon May 30 16:22:53 2022 +0000

    [pre-commit.ci] pre-commit autoupdate

    updates:
    - [github.com/pre-commit/mirrors-mypy: v0.950 → v0.960](pre-commit/mirrors-mypy@v0.950...v0.960)

commit f04b437
Merge: 397fddd e3ebaaa
Author: Anselm Hahn <[email protected]>
Date:   Thu May 26 06:20:13 2022 +0200

    Merge pull request #313 from Anselmoo/dependabot/pip/mypy-0.960

commit e3ebaaa
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Thu May 26 01:45:18 2022 +0000

    Bump mypy from 0.950 to 0.960

    Bumps [mypy](https://github.com/python/mypy) from 0.950 to 0.960.
    - [Release notes](https://github.com/python/mypy/releases)
    - [Commits](python/mypy@v0.950...v0.960)

    ---
    updated-dependencies:
    - dependency-name: mypy
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <[email protected]>

commit 397fddd
Merge: 72d26fa cdf0f1e
Author: Anselm Hahn <[email protected]>
Date:   Mon May 23 06:36:57 2022 +0200

    Merge pull request #312 from Anselmoo/dependabot/pip/dill-0.3.5.1

    Bump dill from 0.3.5 to 0.3.5.1

commit cdf0f1e
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Mon May 23 01:18:24 2022 +0000

    Bump dill from 0.3.5 to 0.3.5.1

    Bumps [dill](https://github.com/uqfoundation/dill) from 0.3.5 to 0.3.5.1.
    - [Release notes](https://github.com/uqfoundation/dill/releases)
    - [Commits](uqfoundation/dill@dill-0.3.5...dill-0.3.5.1)

    ---
    updated-dependencies:
    - dependency-name: dill
      dependency-type: direct:production
      update-type: version-update:semver-patch
    ...

    Signed-off-by: dependabot[bot] <[email protected]>

commit 72d26fa
Merge: 9beeb02 7cf612f
Author: Anselm Hahn <[email protected]>
Date:   Sat May 21 21:16:59 2022 +0200

    Merge pull request #311 from Anselmoo/develop

    Add devcontainer for CodeSpaces

commit 7cf612f
Author: Anselm Hahn <[email protected]>
Date:   Sat May 21 21:15:24 2022 +0200

    Update devcontainer

    * Add devcontainer for CodeSpaces

    * Update devcontainer

    * Add sourcery to devcontainer

    * Prettified Code!

    * Exclude devcontainer for json check
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

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.

1 participant

@Anselmoo