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.
We provide a new, experimental Python handler based on Griffe.
This new handler brings automatic cross-references for every annotation in your code,
including references to third-party libraries' APIs if they provide objects inventories
and you explicitely load them in mkdocs.yml.
See migration notes in the documentation.
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.
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[bot]
commented
1 year ago
Bumps mkdocstrings from 0.17.0 to 0.19.1.
Release notes
Sourced from mkdocstrings's releases.
... (truncated)
Changelog
Sourced from mkdocstrings's changelog.
... (truncated)
Commits
d965cccchore: Prepare release 0.19.1348bdd5fix: Fix regular expression for Sphinx inventory parsinga5ed211chore: Add JSON schema for plugin's options6c3ef79docs: Small improvement34a1512chore: Template upgradeeeeb97bchore: Template upgrade995e5dcdocs: Remove mention of deprecated watch feature from recipes20f6ea4Merge branch 'master' of github.com:mkdocstrings/mkdocstringsefa00b2docs: Clarifycustom_templatesfolder location in options documentatione2fb97bchore: Template upgradeDependabot 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)