Skip to content

Conversation

@czgdp1807
Copy link

@czgdp1807 czgdp1807 commented Dec 18, 2025

Summary

This PR fixes the documentation build failure by correcting the mkdocstrings configuration in mkdocs.yml. The import key 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:

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

This error occurred because the import configuration was incorrectly nested under handlers.python.import instead of being at the root mkdocstrings.import level.

Solution

Moved the import key from:

handlers:
  python:
    options:
      ...
    import:  # Wrong location
      - https://docs.python.org/3/objects.inv

To:

handlers:
  python:
    options:
      ...
import:  # Correct location
  - https://docs.python.org/3/objects.inv

Testing

@czgdp1807 czgdp1807 marked this pull request as ready for review December 19, 2025 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant