Skip to content

warning: The 'import' key is renamed 'inventories' for the Python handler #357

@llucax

Description

@llucax

What happened?

We are getting the following warning when using mkdocs and related tools like mike:

warning: The 'import' key is renamed 'inventories' for the Python handler

What did you expect instead?

Update the mkdocs.yml file to replace:

  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          # ...
          import:

With:

  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          # ...
          inventories:

Extra information

We also need to update the cookiecutter templates and write a migration step in cookiecutter/migration.py.

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:mkdocsAffects the configuration of mkdocspart:templateAffects the cookiecutter template filestype:bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions