Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Feb 4, 2025

Bumps the required group with 7 updates in the / directory:

Package From To
pydoclint 0.5.14 0.6.0
mkdocs-material 9.5.49 9.6.2
mkdocstrings[python] 0.27.0 0.28.0
mkdocstrings-python 1.13.0 1.14.3
pylint 3.3.3 3.3.4
pytest-asyncio 0.25.1 0.25.3
setuptools 75.6.0 75.8.0

Updates pydoclint from 0.5.14 to 0.6.0

Release notes

Sourced from pydoclint's releases.

0.6.0

What's Changed

Full Changelog: jsh9/pydoclint@0.5.19...0.6.0

0.5.19

What's Changed

Full Changelog: jsh9/pydoclint@0.5.18...0.5.19

0.5.18

What's Changed

Full Changelog: jsh9/pydoclint@0.5.17...0.5.18

0.5.17

What's Changed

Full Changelog: jsh9/pydoclint@0.5.16...0.5.17

0.5.16

What's Changed

Full Changelog: jsh9/pydoclint@0.5.15...0.5.16

0.5.15

What's Changed

Full Changelog: jsh9/pydoclint@0.5.14...0.5.15

Changelog

Sourced from pydoclint's changelog.

[0.6.0] - 2025-01-13

  • Added
    • A new violation code, DOC003, to detect docstring style mismatch (when docstrings are written in the style different from specified)
  • Full diff

[0.5.19] - 2025-01-12

  • Fixed
    • False positive DOC405 and DOC201 when we have bare return statements together with yield statements
  • Added
    • A new config option --should-document-star-arguments (if False, star arguments such as *args and **kwargs should not be documented in the docstring)
    • A pre-commit step to check that "Full diff" is always added in CHANGELOG.md
  • Full diff

[0.5.18] - 2025-01-12

  • Fixed
    • An issue where custom exceptions such as a.b.c.MyException.from_str cannot be properly parsed and compared
    • A minor wording issue in DOC503 violation message
  • Full diff

[0.5.17] - 2025-01-12

  • Added
    • A new config option --auto-regenerate-baseline to automatically regenerate the baseline file for every successful pydoclint run
  • Full diff

[0.5.16] - 2025-01-11

[0.5.15] - 2025-01-10

  • Changed

... (truncated)

Commits
  • 2e8af22 Add DOC003 to check docstring style mismatch (#207)
  • 94039b2 Add new config option for documenting star arguments (#206)
  • 22b9b37 Fix false positive DOC405 & DOC201 for bare returns (#205)
  • 1f2ea57 Fix wording in DOC503 violation message (#204)
  • 91263b8 Fix parsing and comparison of chained custom exceptions (#203)
  • 64ef923 Add tips, tricks, and pitfalls to README
  • fe188f4 Add an option to auto regenerate baseline (#202)
  • 7282eb6 👌 Add pre-commit-hook to run pydoclint via flake8 (#200)
  • 4021d8d Throw DOC001 when docstring sections can't be parsed (numpy style) (#199)
  • See full diff in compare view

Updates mkdocs-material from 9.5.49 to 9.6.2

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-9.6.2

  • Fixed #7955: Excessively long words don't break on narrow screens
  • Fixed #7947: Scope setting interferes with outdated version banner

mkdocs-material-9.6.1

  • Fixed #7943: Tags plugin crashing due to merge error

mkdocs-material-9.6.0

  • Added meta plugin
  • Rewrite of the tags plugin
  • Added support for allow lists in tags plugin
  • Added support for and custom sorting in tags plugin
  • Added support for related links in blog plugin
  • Added support for custom index pages in blog plugin
  • Added support for navigation subtitles
  • Fixed #7924: Anchors might require two clicks when using instant navigation

mkdocs-material-9.5.50

  • Fixed #7913: Social plugin renders attribute lists in page title
Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.6.2 (2025-02-03)

  • Fixed #7955: Excessively long words don't break on narrow screens
  • Fixed #7947: Scope setting interferes with outdated version banner

mkdocs-material-9.6.1 (2025-01-31)

  • Fixed #7943: Tags plugin crashing due to merge error

mkdocs-material-9.6.0 (2025-01-31)

  • Added meta plugin
  • Rewrite of the tags plugin
  • Added support for allow lists in tags plugin
  • Added support for and custom sorting in tags plugin
  • Added support for related links in blog plugin
  • Added support for custom index pages in blog plugin
  • Added support for navigation subtitles
  • Fixed #7924: Anchors might require two clicks when using instant navigation

mkdocs-material-9.5.50 (2025-01-18)

  • Fixed #7913: Social plugin renders attribute lists in page title

mkdocs-material-9.5.49+insiders-4.53.15 (2025-01-15)

  • Fixed #7896: Scoped tags listings not rendering in subsections

mkdocs-material-9.5.49 (2024-12-16)

  • Adjusted title color in dark mode for all supported Mermaid.js diagrams
  • Fixed #7803: Privacy plugin crashes on generated files
  • Fixed #7781: Mermaid.js flow chart title not visible in dark mode

mkdocs-material-9.5.48 (2024-12-08)

  • Fixed #7774: Disabling social cards doesn't work

mkdocs-material-9.5.47 (2024-12-01)

  • Fixed #7750: Numeric tags break search
  • Fixed #7748: Blog plugin breaks when using future drafts (9.5.45 regression)

mkdocs-material-9.5.46 (2024-11-25)

  • Added support for removing preload hints in privacy plugin
  • Fixed #7734: Code blocks in h5 headlines are uppercased
  • Fixed #7725: Blog plugin crashing on missing timezone (9.5.45 regression)

mkdocs-material-9.5.45 (2024-11-20)

... (truncated)

Commits

Updates mkdocstrings[python] from 0.27.0 to 0.28.0

Release notes

Sourced from mkdocstrings[python]'s releases.

0.28.0

0.28.0 - 2025-02-03

Compare with 0.27.0

Breaking Changes

Although the following changes are "breaking" in terms of public API, we didn't find any public use of these classes and methods on GitHub.

  • mkdocstrings.extension.AutoDocProcessor.__init__(parser): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(md): Positional parameter was moved
  • mkdocstrings.extension.AutoDocProcessor.__init__(config): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(handlers): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.AutoDocProcessor.__init__(autorefs): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.MkdocstringsExtension.__init__(config): Parameter was removed
  • mkdocstrings.extension.MkdocstringsExtension.__init__(handlers): Positional parameter was moved
  • mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs): Positional parameter was moved
  • mkdocstrings.handlers.base.Handlers.__init__(config): Parameter was removed
  • mkdocstrings.handlers.base.Handlers.__init__(theme): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(default): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(inventory_project): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(tool_config): Parameter was added as required

Similarly, the following parameters were renamed, but the methods are only called from our own code, using positional arguments.

  • mkdocstrings.handlers.base.BaseHandler.collect(config): Parameter was renamed options
  • mkdocstrings.handlers.base.BaseHandler.render(config): Parameter was renamed options

Finally, the following method was removed, but this is again taken into account in our own code:

  • mkdocstrings.handlers.base.BaseHandler.get_anchors: Public object was removed

For these reasons, and because we're still in v0, we do not bump to v1 yet. See following deprecations.

Deprecations

mkdocstrings 0.28 will start emitting these deprecations warnings:

The handler argument is deprecated. The handler name must be specified as a class attribute.

Previously, the get_handler function would pass a handler (name) argument to the handler constructor. This name must now be set on the handler's class directly.

class MyHandler:
name = "myhandler"

The domain attribute must be specified as a class attribute.

The domain class attribute on handlers is now mandatory and cannot be an empty string.

... (truncated)

Changelog

Sourced from mkdocstrings[python]'s changelog.

0.28.0 - 2025-02-03

Compare with 0.27.0

Breaking Changes

Although the following changes are "breaking" in terms of public API, we didn't find any public use of these classes and methods on GitHub.

  • mkdocstrings.extension.AutoDocProcessor.__init__(parser): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(md): Positional parameter was moved
  • mkdocstrings.extension.AutoDocProcessor.__init__(config): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(handlers): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.AutoDocProcessor.__init__(autorefs): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.MkdocstringsExtension.__init__(config): Parameter was removed
  • mkdocstrings.extension.MkdocstringsExtension.__init__(handlers): Positional parameter was moved
  • mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs): Positional parameter was moved
  • mkdocstrings.handlers.base.Handlers.__init__(config): Parameter was removed
  • mkdocstrings.handlers.base.Handlers.__init__(theme): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(default): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(inventory_project): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(tool_config): Parameter was added as required

Similarly, the following parameters were renamed, but the methods are only called from our own code, using positional arguments.

  • mkdocstrings.handlers.base.BaseHandler.collect(config): Parameter was renamed options
  • mkdocstrings.handlers.base.BaseHandler.render(config): Parameter was renamed options

Finally, the following method was removed, but this is again taken into account in our own code:

  • mkdocstrings.handlers.base.BaseHandler.get_anchors: Public object was removed

For these reasons, and because we're still in v0, we do not bump to v1 yet. See following deprecations.

Deprecations

mkdocstrings 0.28 will start emitting these deprecations warnings:

The handler argument is deprecated. The handler name must be specified as a class attribute.

Previously, the get_handler function would pass a handler (name) argument to the handler constructor. This name must now be set on the handler's class directly.

class MyHandler:
    name = "myhandler"

The domain attribute must be specified as a class attribute.

The domain class attribute on handlers is now mandatory and cannot be an empty string.

... (truncated)

Commits
  • 6ef1412 chore: Prepare release 0.28.0
  • 936275e Merge branch 'main' of github.com:mkdocstrings/mkdocstrings
  • 3cf7d51 fix: Update handlers in JSON schema to be an object instead of an array
  • f3ecf58 chore: Ignore autorefs fallback deprecation warning
  • 9618e17 docs: Mention mkdocs-api-autonav in recipe
  • 52ea2f2 ci: Upgrade dev-deps to prevent warnings in tests
  • 8c476ee refactor: Pass config_file_path to get_handler if it expects it
  • 053ef23 Merge branch 'main' of github.com:mkdocstrings/mkdocstrings
  • 48625a2 chore: Fix inventory loading error log message
  • 060e437 docs: Fix link to arithmatex docs in Material for MkDocs
  • Additional commits viewable in compare view

Updates mkdocstrings-python from 1.13.0 to 1.14.3

Release notes

Sourced from mkdocstrings-python's releases.

1.14.3

1.14.3 - 2025-02-04

Compare with 1.14.2

Bug Fixes

  • Let dataclass implement __init__ method, set extra fields in get_options (477b9e4 by Timothée Mazzucotelli).

1.14.2

1.14.2 - 2025-02-03

Compare with 1.14.1

Bug Fixes

  • Deactivate Pydantic logic if v1 is installed instead of v2 (c5ecd70 by Timothée Mazzucotelli). Issue-240

1.14.1

1.14.1 - 2025-02-03

Compare with 1.14.0

Bug Fixes

  • Fix type errors with options during collection and docstring parsing (15ca6d8 by Timothée Mazzucotelli).

1.14.0

1.14.0 - 2025-02-03

Compare with 1.13.0

Features

Code Refactoring

  • Use dataclasses for configuration/options and automate schema generation (5ebeda6 by Timothée Mazzucotelli).
Changelog

Sourced from mkdocstrings-python's changelog.

1.14.3 - 2025-02-04

Compare with 1.14.2

Bug Fixes

  • Let dataclass implement __init__ method, set extra fields in get_options (477b9e4 by Timothée Mazzucotelli).

1.14.2 - 2025-02-03

Compare with 1.14.1

Bug Fixes

  • Deactivate Pydantic logic if v1 is installed instead of v2 (c5ecd70 by Timothée Mazzucotelli). Issue-240

1.14.1 - 2025-02-03

Compare with 1.14.0

Bug Fixes

  • Fix type errors with options during collection and docstring parsing (15ca6d8 by Timothée Mazzucotelli).

1.14.0 - 2025-02-03

Compare with 1.13.0

Features

Code Refactoring

  • Use dataclasses for configuration/options and automate schema generation (5ebeda6 by Timothée Mazzucotelli).
Commits
  • e74ecbf chore: Prepare release 1.14.3
  • 477b9e4 fix: Let dataclass implement __init__ method, set extra fields in `get_opti...
  • 40067f7 chore: Prepare release 1.14.2
  • c5ecd70 fix: Deactivate Pydantic logic if v1 is installed instead of v2
  • e14d5b4 chore: Prepare release 1.14.1
  • 15ca6d8 fix: Fix type errors with options during collection and docstring parsing
  • c8bee99 chore: Prepare release 1.14.0
  • 95bba88 docs: Make sure each option is documented
  • 73292f5 docs: Sort options, document extra and extensions, add warnings on no-eff...
  • 5ebeda6 refactor: Use dataclasses for configuration/options and automate schema gener...
  • Additional commits viewable in compare view

Updates pylint from 3.3.3 to 3.3.4

Commits

Updates pytest-asyncio from 0.25.1 to 0.25.3

Release notes

Sourced from pytest-asyncio's releases.

pytest-asyncio 0.25.3

  • Avoid errors in cleanup of async generators when event loop is already closed #1040

pytest-asyncio 0.25.2

  • Call loop.shutdown_asyncgens() before closing the event loop to ensure async generators are closed in the same manner as asyncio.run does #1034
Commits
  • 7c50192 fix: Avoid errors in cleanup of async generators when event loop is already c...
  • 2188cdb build: Prepare release of v0.25.2.
  • c3ad634 fix: Shutdown generators before closing event loops.
  • e8ffb10 [pre-commit.ci] pre-commit autoupdate
  • aae43d4 Build(deps): Bump hypothesis in /dependencies/default
  • 941e8b5 Build(deps): Bump pygments from 2.18.0 to 2.19.1 in /dependencies/docs
  • See full diff in compare view

Updates setuptools from 75.6.0 to 75.8.0

Changelog

Sourced from setuptools's changelog.

v75.8.0

Features

  • Implemented Dynamic field for core metadata (as introduced in PEP 643). The existing implementation is currently experimental and the exact approach may change in future releases. (#4698)

v75.7.0

Features

Commits
  • 5c9d980 Bump version: 75.7.0 → 75.8.0
  • 72c4222 Avoid using Any in function
  • 1c61d47 Add news fragments for PEP 643
  • f285d01 Implement PEP 643 (Dynamic field for core metadata) (#4698)
  • a50f6e2 Fix _static.Dict.ior for Python 3.8
  • b055895 Add extra tests for static/dynamic metadata
  • 770b4fc Remove test workaround for unmarked static values from pyproject.toml
  • 8b22d73 Mark values from pyproject.toml as static
  • f699fd8 Fix spelling error
  • 8b4c8a3 Add tests for static 'attr' directive
  • Additional commits viewable in compare view

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 show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
  • @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
  • @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
  • @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
  • @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

Bumps the required group with 7 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [pydoclint](https://github.com/jsh9/pydoclint) | `0.5.14` | `0.6.0` |
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) | `9.5.49` | `9.6.2` |
| [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) | `0.27.0` | `0.28.0` |
| [mkdocstrings-python](https://github.com/mkdocstrings/python) | `1.13.0` | `1.14.3` |
| [pylint](https://github.com/pylint-dev/pylint) | `3.3.3` | `3.3.4` |
| [pytest-asyncio](https://github.com/pytest-dev/pytest-asyncio) | `0.25.1` | `0.25.3` |
| [setuptools](https://github.com/pypa/setuptools) | `75.6.0` | `75.8.0` |



Updates `pydoclint` from 0.5.14 to 0.6.0
- [Release notes](https://github.com/jsh9/pydoclint/releases)
- [Changelog](https://github.com/jsh9/pydoclint/blob/main/CHANGELOG.md)
- [Commits](jsh9/pydoclint@0.5.14...0.6.0)

Updates `mkdocs-material` from 9.5.49 to 9.6.2
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.49...9.6.2)

Updates `mkdocstrings[python]` from 0.27.0 to 0.28.0
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.27.0...0.28.0)

Updates `mkdocstrings-python` from 1.13.0 to 1.14.3
- [Release notes](https://github.com/mkdocstrings/python/releases)
- [Changelog](https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/python@1.13.0...1.14.3)

Updates `pylint` from 3.3.3 to 3.3.4
- [Release notes](https://github.com/pylint-dev/pylint/releases)
- [Commits](pylint-dev/pylint@v3.3.3...v3.3.4)

Updates `pytest-asyncio` from 0.25.1 to 0.25.3
- [Release notes](https://github.com/pytest-dev/pytest-asyncio/releases)
- [Commits](pytest-dev/pytest-asyncio@v0.25.1...v0.25.3)

Updates `setuptools` from 75.6.0 to 75.8.0
- [Release notes](https://github.com/pypa/setuptools/releases)
- [Changelog](https://github.com/pypa/setuptools/blob/main/NEWS.rst)
- [Commits](pypa/setuptools@v75.6.0...v75.8.0)

---
updated-dependencies:
- dependency-name: pydoclint
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: mkdocstrings[python]
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: mkdocstrings-python
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
- dependency-name: pylint
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: required
- dependency-name: pytest-asyncio
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: required
- dependency-name: setuptools
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: required
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot requested review from a team as code owners February 4, 2025 09:48
@dependabot dependabot bot requested a review from thea-leake February 4, 2025 09:48
@dependabot dependabot bot added part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:tech-debt Improves the project without visible changes for users labels Feb 4, 2025
@llucax llucax enabled auto-merge February 4, 2025 09:49
llucax
llucax previously approved these changes Feb 4, 2025
@llucax
Copy link
Contributor

llucax commented Feb 10, 2025

@github-actions github-actions bot added the part:docs Affects the documentation label Feb 10, 2025
@llucax
Copy link
Contributor

llucax commented Feb 10, 2025

Upgraded to repo-config v0.12.0 to fix the issues. Needs another approval.

@llucax
Copy link
Contributor

llucax commented Feb 10, 2025

Oh damn, still something is failing.

@llucax
Copy link
Contributor

llucax commented Feb 11, 2025

repo-config v0.12.1 coming up soon.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax llucax force-pushed the dependabot/pip/required-c547314b89 branch from b3e6bbe to 83d15a4 Compare February 11, 2025 13:35
@llucax
Copy link
Contributor

llucax commented Feb 11, 2025

Updated to repo-config 0.12.2.

The new version of the plugin will warn if there are multiple
references to the same object, for example:

```
WARNING -  mkdocs_autorefs: Multiple secondary URLs found for
  'frequenz.client.base.exception.ApiClientError.description':
  ['reference/frequenz/client/microgrid/#frequenz.client.microgrid.ApiClientError.description',
  'reference/frequenz/client/microgrid/#frequenz.client.microgrid.ClientNotConnected.description'].
```

To avoid this we enable the `resolve_closest` option:
https://mkdocstrings.github.io/autorefs/#non-unique-headings

But this looks like a bug in the plugin, so we'll see:
mkdocstrings/autorefs#52 (comment)

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax
Copy link
Contributor

llucax commented Feb 11, 2025

I needed to enable an option for the docs generation to avoid some warnings that I think is a bug, but we'll see.

Will force-merge if everything is finally green 💚, as this is routine dependencies update that just went wrong and took a little bit of extra effort to fix.

@llucax llucax disabled auto-merge February 11, 2025 14:04
@llucax llucax merged commit 50dd3a9 into v0.x.x Feb 11, 2025
16 checks passed
@llucax llucax deleted the dependabot/pip/required-c547314b89 branch February 11, 2025 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:tech-debt Improves the project without visible changes for users

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant