mkdocs gh-deploy --force throwing ImportError

[david26694]

I'm deploying docs via a github action in here, see github workflow.

I have the following trace:

Run mkdocs gh-deploy --force
  mkdocs gh-deploy --force
  shell: /usr/bin/bash -e {0}
  env:
    pythonLocation: /opt/hostedtoolcache/Python/3.8.18/x64
Traceback (most recent call last):
  File "/opt/hostedtoolcache/Python/3.8.18/x64/bin/mkdocs", line 8, in <module>
    sys.exit(cli())
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/click/core.py", line 1157, in __call__
    return self.main(*args, **kwargs)
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/click/core.py", line 1078, in main
    rv = self.invoke(ctx)
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/click/core.py", line 1688, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/click/core.py", line 1434, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/click/core.py", line 783, in invoke
    return __callback(*args, **kwargs)
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocs/__main__.py", line 209, in gh_deploy_command
    cfg = config.load_config(
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocs/config/base.py", line 224, in load_config
    errors, warnings = cfg.validate()
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocs/config/base.py", line 108, in validate
    run_failed, run_warnings = self._validate()
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocs/config/base.py", line 63, in _validate
    self[key] = config_option.validate(value)
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocs/config/config_options.py", line 130, in validate
    return self.run_validation(value)
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocs/config/config_options.py", line 679, in run_validation
    plgins[item] = self.load_plugin(item, cfg)
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocs/config/config_options.py", line 692, in load_plugin
    Plugin = self.installed_plugins[name].load()
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/importlib_metadata/__init__.py", line 184, in load
    module = import_module(match.group('module'))
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 843, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocstrings/plugin.py", line 28, in <module>
    from mkdocs_autorefs.plugin import AutorefsPlugin
  File "/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocs_autorefs/plugin.py", line 21, in <module>
    from mkdocs.config.defaults import MkDocsConfig
ImportError: cannot import name 'MkDocsConfig' from 'mkdocs.config.defaults' (/opt/hostedtoolcache/Python/3.8.18/x64/lib/python3.8/site-packages/mkdocs/config/defaults.py)

This used to work yesterday but it's not working anymore. I'm using mkdocs==1.3.0:

docs_packages = [
    "mkdocs==1.3.0",
    "mkdocs-material==8.5.0",
    "mkdocstrings==0.18.0",
    "jinja2<3.1.0",
    "mkdocs-jupyter==0.22.0",
    "plotnine==0.8.0",
    "matplotlib>=3.4.3",
]

do you know what can I do to address this?

fyi @pinsacco

[oprypin]

mkdocs-autorefs made a release that accidentally requires MkDocs 1.4+

mkdocstrings/autorefs@a215a97#diff-1681abe3d10f2ea6f96879d51ae21d3bdf7a87ec42cf2a533f761a4d9f53449bR21
@pawamoy

You'd have to pin its version too

[pawamoy]

Oops! Thanks for the heads up, will do.

[oprypin]

@pawamoy I think what's needed is to just delete this line and probably it can still support old MkDocs just fine?

[david26694]

thanks, it works now!

[pawamoy]

Just published mkdocs-autorefs 1.0.1 with the suggested fix 🙂