chore(deps): update dependency mkdocstrings-python to v1.12.2
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| mkdocstrings-python (changelog) | 1.7.5 -> 1.12.2 |
Release Notes
mkdocstrings/python (mkdocstrings-python)
v1.12.2
Bug Fixes
- Always render cross-references outside of signatures (73f11dc by Timothée Mazzucotelli). Issue-mkdocstrings#700
v1.12.1
Bug Fixes
v1.12.0
Build
- Drop support for Python 3.8 (6615c91 by Timothée Mazzucotelli).
Features
- Auto-summary of members (7f9757d by Timothée Mazzucotelli).
- Render function overloads (0f2c25c by Timothée Mazzucotelli).
- Parameter headings, more automatic cross-references (0176b83 by Timothée Mazzucotelli).
Code Refactoring
v1.11.1
Code Refactoring
- Prepare
relative_crossrefsandscoped_crossrefsinsiders features (dd8b014 by Timothée Mazzucotelli).
v1.11.0
Features
- Hook into autorefs to provide context around cross-ref errors (bb4be5b by Timothée Mazzucotelli).
v1.10.9
Build
- Explicitly depend on mkdocs-autorefs to be able to specify lower bound (2299ab5 by Timothée Mazzucotelli).
Code Refactoring
- Use new autorefs syntax (68cb72f by Timothée Mazzucotelli).
v1.10.8
Build
- Depend on Griffe 0.49 (a87dcad by Timothée Mazzucotelli).
v1.10.7
Packaging
- Include tests and all relevant files for downstream packaging in source distribution
v1.10.6
Bug Fixes
- Fix condition to display members (check all members, not just non-inherited ones) (3d838a9 by Timothée Mazzucotelli).
Code Refactoring
- Update code for Griffe 0.48 (removing deprecation warnings) (eff10cc by Timothée Mazzucotelli). Issue-173
v1.10.5
Bug Fixes
- Mix both previous checks for displaying objects: not imported or public (587963b by Timothée Mazzucotelli). Issue-294
v1.10.4
Code Refactoring
- Only filter out imported objects instead of non-public ones after applying filters (e2f4b35 by Timothée Mazzucotelli). Issue-mkdocstrings/griffe-294
- Update code for Griffe 0.46 to avoid deprecation warnings (321b407 by Timothée Mazzucotelli).
- Change
load_external_modulesdefault value toNoneto support new default mode in Griffe (ae5896c by Timothée Mazzucotelli).
v1.10.3
Bug Fixes
- Don't crash when rendering the source of an object whose lineno is none (64df00b by Timothée Mazzucotelli). Issue-163
v1.10.2
Bug Fixes
- Actually make use of custom .html.jinja templates (5668abb by Timothée Mazzucotelli).
v1.10.1
Build
- Depend on mkdocstrings 0.25 which adds support for parameter
oncewhen logging messages (2bc156b by Timothée Mazzucotelli).
Code Refactoring
- Set handler's name (a71ab12 by Timothée Mazzucotelli).
- Update
*.htmltop-level templates to extend the*.html.jinjabase templates (a8c540e by Timothée Mazzucotelli). Issue-151 - Update
*.htmlbase templates to extend their*.html.jinjacounterpart, while overriding thelogsblock to issue a logging message (info) stating that extending*.htmltemplates is deprecated (e6f1b9c by Timothée Mazzucotelli). Issue-151 - Add
*.html.jinjatop-level (overridable) templates, extending their base counterpart (7c14924 by Timothée Mazzucotelli). Issue-151 - Add
*.html.jinjabase templates, which are copies of*.htmltemplates, with an additionallogsblock, and using the updatedget_templatefilter (eced9a5 by Timothée Mazzucotelli). Issue-151 - Update
get_templatefilter to support both*.htmland*.html.jinjatemplates, logging a message (info) when*.htmltemplates are overridden by users (3546fd7 by Timothée Mazzucotelli). Issue-151 - Log a warning when base templates are overridden (26e3d66 by Timothée Mazzucotelli). Issue-151
v1.10.0
Features
- Add CSS classes
doc-section-titleanddoc-section-itemin docstring sections (d6e1d68 by Timothée Mazzucotelli). Issue-17
Bug Fixes
- Render enumeration instance name instead of just "value", allowing proper cross-reference (11d81d8 by Timothée Mazzucotelli). Issue-124
v1.9.2
Dependencies
- Remove cap on Python-Markdown 3.6 now that ToC labels are fixed by mkdocstrings (0c1e2c1 by Timothée Mazzucotelli).
v1.9.1
Bug Fixes
Code Refactoring
- Allow first name in a separate signature to be highlighted as a function name (f798a1e by Timothée Mazzucotelli).
- Maintain original Pygments color for cross-refs in signatures (7c8b885 by Timothée Mazzucotelli).
v1.9.0
Dependencies
- Add upper bound on Python-Markdown 3.6 to temporarily prevent breaking changes (cd93ee3 by Timothée Mazzucotelli).
Features
- Add
show_labelsoption to show/hide labels (eaf9b82 by Viicos). Issue #120, PR #130 - Add option to search for stubs packages (0c6aa32 by Romain). PR #128, PR griffe#221: : https://github.com/mkdocstrings/griffe/pull/221
Code Refactoring
- Mark all Jinja blocks as scoped (548bdad by Timothée Mazzucotelli).
v1.8.0
Features
-
Release Insiders features of the $500/month funding goal (bd30106 by Timothée Mazzucotelli). The features and projects related to mkdocstrings-python are:
- Cross-references for type annotations in signatures
- Symbol types in headings and table of contents
griffe-inherited-docstrings, a Griffe extension for inheriting docstringsgriffe2md, a tool to output API docs to Markdown using Griffe
See the complete list of features and projects here: https://pawamoy.github.io/insiders/#500-plasmavac-user-guide.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ 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 was generated by Mend Renovate. View the repository job log.