Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide clear error message, when package cannot be found #193

Open
isabelizimm opened this issue Jun 23, 2023 · 2 comments
Open

Provide clear error message, when package cannot be found #193

isabelizimm opened this issue Jun 23, 2023 · 2 comments
Labels
time:short Takes an hour or less to resolve

Comments

@isabelizimm
Copy link
Collaborator

Hey there--

Not sure what the change is, but with quartodoc==0.3.4 and griffe==0.29.1 (both of the latest versions), my doc builds are failing with an error of:

    raise WorkaroundKeyError(e.args[0])
quartodoc.builder.utils.WorkaroundKeyError: VetiverModel

See full logs here

My docs pass when I have quartodoc==0.3.4 and griffe==0.25.1, so this is not blocking me, I'll just use that configuration of dependencies in the meantime 😄

@machow
Copy link
Owner

machow commented Jun 27, 2023

I think this is related to mkdocstrings/griffe#172

The underlying pth files (which are used for editable installs) are using a funky format, that is causing griffe not to be able to find vetiver. I'll submit a PR there in a sec!

@machow
Copy link
Owner

machow commented Jun 27, 2023

Since this error was about the underlying package not being found, it was confusing that the message was about a specific entry. Let's make sure the message that pops up here says something like, "package X can't be found" (e.g. by an early check, or drilling down when the error occurs).

@machow machow changed the title quartodoc.builder.utils.WorkaroundKeyError with griffe 0.29.1 Provide clear error message, when package cannot be found Jun 27, 2023
@machow machow added the time:short Takes an hour or less to resolve label Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
time:short Takes an hour or less to resolve
Projects
Status: No status
Development

No branches or pull requests

2 participants