Skip to content

Comments

Add support for mkdocstrings-python v2#481

Merged
llucax merged 5 commits intofrequenz-floss:v0.x.xfrom
llucax:mkdocstrings-python-2
Dec 5, 2025
Merged

Add support for mkdocstrings-python v2#481
llucax merged 5 commits intofrequenz-floss:v0.x.xfrom
llucax:mkdocstrings-python-2

Conversation

@llucax
Copy link
Contributor

@llucax llucax commented Dec 4, 2025

Fixes #482, #483, #357.

@llucax llucax requested a review from a team as a code owner December 4, 2025 13:17
@llucax llucax requested review from shsms and removed request for a team December 4, 2025 13:17
@github-actions github-actions bot added part:docs Affects the documentation part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) labels Dec 4, 2025
@llucax
Copy link
Contributor Author

llucax commented Dec 4, 2025

This is more complicated than I anticipated:

@llucax llucax added the type:enhancement New feature or enhancement visitble to users label Dec 4, 2025
@llucax llucax marked this pull request as draft December 4, 2025 13:33
This doesn't mean that downstream projects will automatically work with
`mkdocstrings-python` v2, as some configuration changes might be needed.

We need to update the templates and add steps to the migration script in
future releases to help with the transition.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Using `paths` as `options` in `mkdocs.yml` was deprecated a long ago.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
@llucax llucax force-pushed the mkdocstrings-python-2 branch from f11318e to 71e7680 Compare December 4, 2025 14:08
@github-actions github-actions bot added the part:template Affects the cookiecutter template files label Dec 4, 2025
@llucax llucax changed the base branch from v0.13.x to v0.x.x December 4, 2025 14:08
@llucax llucax self-assigned this Dec 4, 2025
@llucax llucax marked this pull request as ready for review December 4, 2025 14:13
@llucax llucax enabled auto-merge December 4, 2025 14:13
@llucax
Copy link
Contributor Author

llucax commented Dec 4, 2025

OK, now it should be ready.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
@llucax llucax force-pushed the mkdocstrings-python-2 branch from 71e7680 to 99511e2 Compare December 5, 2025 07:35
@llucax llucax added this pull request to the merge queue Dec 5, 2025
github-merge-queue bot pushed a commit that referenced this pull request Dec 5, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 5, 2025
@llucax llucax added this pull request to the merge queue Dec 5, 2025
Merged via the queue into frequenz-floss:v0.x.x with commit 69d3c93 Dec 5, 2025
6 checks passed
@llucax llucax deleted the mkdocstrings-python-2 branch December 5, 2025 08:04
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:template Affects the cookiecutter template files part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) type:enhancement New feature or enhancement visitble to users

Projects

None yet

Development

Successfully merging this pull request may close these issues.

paths was moved out of options Support mkdocstrings-python v2 warning: The 'import' key is renamed 'inventories' for the Python handler

2 participants