fix: correct mkdocstrings import config for v2.0 compatibility #225
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes the documentation build failure by correcting the
mkdocstringsconfiguration inmkdocs.yml. Theimportkey has been moved from the handler-specific options to the plugin root level, which is the correct location for mkdocstrings-python 2.0+.Problem
The documentation build was failing with the following error:
This error occurred because the
importconfiguration was incorrectly nested underhandlers.python.importinstead of being at the rootmkdocstrings.importlevel.Solution
Moved the
importkey from:To:
Testing
mkdocs buildmkdocs serveworks correctly