Skip to content
This repository has been archived by the owner on Feb 21, 2023. It is now read-only.

Bump mkdocstrings from 0.17.0 to 0.20.0 #1479

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 20, 2023

Bumps mkdocstrings from 0.17.0 to 0.20.0.

Release notes

Sourced from mkdocstrings's releases.

0.20.0

Features

Bug Fixes

Code Refactoring

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)

0.18.0

Highlights

  • Python 3.6 support is dropped.
  • We provide a new, experimental Python handler based on Griffe. This new handler brings automatic cross-references for every annotation in your code,

... (truncated)

Changelog

Sourced from mkdocstrings's changelog.

0.20.0 - 2023-01-19

Compare with 0.19.1

Features

Bug Fixes

Code Refactoring

0.19.1 - 2022-12-13

Compare with 0.19.0

Bug Fixes

Code Refactoring

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

... (truncated)

Commits
  • 8c952c9 chore: Prepare release 0.20.0
  • 105ed82 refactor: Make _load_inventory accept lists as arguments
  • 4a8a26c docs: Fix a few grammar mistakes
  • a6ea80c fix: Handle updating Jinja environment of multiple handlers
  • 8cf117d feat: Add enabled configuration option
  • 5cc8939 tests: Remove unused fixture
  • cbfb55d ci: Fix quality warnings
  • d10e2d0 tests: Fix programmatic build in tests
  • ac963c8 refactor: Remove support for MkDocs < 1.2
  • 29036d9 chore: Template upgrade
  • 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.17.0 to 0.20.0.
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/master/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.17.0...0.20.0)

---
updated-dependencies:
- dependency-name: mkdocstrings
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants