Skip to content

Fix mkdocs python path for API repos#534

Merged
llucax merged 4 commits intofrequenz-floss:v0.x.xfrom
llucax:fix-api-paths
Mar 10, 2026
Merged

Fix mkdocs python path for API repos#534
llucax merged 4 commits intofrequenz-floss:v0.x.xfrom
llucax:fix-api-paths

Conversation

@llucax
Copy link
Contributor

@llucax llucax commented Mar 9, 2026

The mkdocstrings-python v2 migration added in v0.14.0 moved the paths setting out of handlers.python.options assuming src, but api repositories use py, so they were not fixed automatically.

llucax added 4 commits March 9, 2026 14:45
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Also remove the more specific `read_project_type()` as it can be
replaced by `read_cookiecutter_str_var("type")`.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
It is hard to keep remembering to update the tag, so better use a
placeholder.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
The mkdocstrings-python v2 migration added in v0.14.0 moved the
`paths` setting out of `handlers.python.options` assuming `src`, but api
repositories use `py`, so they were not fixed automatically.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
@github-actions github-actions bot added part:docs Affects the documentation part:cookiecutter Affects the generation of projects using cookiecutter labels Mar 9, 2026
@llucax llucax self-assigned this Mar 9, 2026
@llucax
Copy link
Contributor Author

llucax commented Mar 9, 2026

Draft because it is based on #533, but I guess we can actually merge that as part of this PR too, so will remove the draft.

@llucax llucax added this to the v0.16.0 milestone Mar 9, 2026
@llucax llucax marked this pull request as ready for review March 9, 2026 15:27
@llucax llucax requested a review from a team as a code owner March 9, 2026 15:27
@llucax llucax requested review from daniel-zullo-frequenz and removed request for a team March 9, 2026 15:27
@llucax llucax enabled auto-merge March 9, 2026 15:58
@llucax llucax disabled auto-merge March 9, 2026 15:58
@llucax llucax added this pull request to the merge queue Mar 10, 2026
Merged via the queue into frequenz-floss:v0.x.x with commit e9da7af Mar 10, 2026
6 checks passed
@llucax llucax deleted the fix-api-paths branch March 10, 2026 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:cookiecutter Affects the generation of projects using cookiecutter part:docs Affects the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants