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

mkdocstrings v0.28.0 causes hyp3-docs build to fail #498

Open
jtherrmann opened this issue Feb 6, 2025 · 2 comments
Open

mkdocstrings v0.28.0 causes hyp3-docs build to fail #498

jtherrmann opened this issue Feb 6, 2025 · 2 comments
Labels
Jira Bug Create a Jira Bug for this issue

Comments

@jtherrmann
Copy link
Contributor

jtherrmann commented Feb 6, 2025

Jira: https://asfdaac.atlassian.net/browse/TOOL-3477

Note: The above link is accessible only to members of ASF.


The mkdocstrings v0.28.0 release causes mkdocs build to fail with:

TypeError: PythonConfig.__init__() got an unexpected keyword argument 'inherited_members'

We've pinned to 0.27.0 but we should fix the error and upgrade. The release notes list several breaking changes but I'm not seeing the culprit at a glance.

@jtherrmann jtherrmann added the Jira Bug Create a Jira Bug for this issue label Feb 6, 2025
@pawamoy
Copy link

pawamoy commented Feb 6, 2025

Hello! Looks like you're adding the inherited_members option under the python key, while it should be under python.options in mkdocs.yml :) Same for show_root_toc_entry. Previously this kind of error was silent.

@jtherrmann
Copy link
Contributor Author

Hello! Looks like you're adding the inherited_members option under the python key, while it should be under python.options in mkdocs.yml :) Same for show_root_toc_entry. Previously this kind of error was silent.

Awesome, thanks! We'll give that a shot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Jira Bug Create a Jira Bug for this issue
Projects
None yet
Development

No branches or pull requests

2 participants