Cannot run insiders with the optimization plugin - Config value "plugins": The "optimize" plugin is not installed

[AnastasiaTWW]

Hello! I've faced with the following problem: I've installed mkdocs-material 9.4.14+insiders.4.46.0 and try to run the optimize plugin (including image optimization).

The mkdocs.yml part with the optimize plugin activation looks like this:

plugins:
  - search
  - minify:
      minify_html: true
  - meta-descriptions
  - glightbox:
      skip_classes:
        - non-zoomable
  - optimize

requirements.txt looks like this:

mkdocs==1.5.3
pymdown-extensions==10.5
pygments==2.17.2
mkdocs-minify-plugin==0.7.1
prependnewline==1.2
mkdocs-meta-descriptions-plugin==3.0.0
markdown==3.5.1
importlib_metadata==7.0.0
mkdocs-glightbox==0.3.5
mkdocs-material[imaging]
git+https://${CLONE_INSIDERS_TOKEN}:x-oauth-basic@github.com/<private_fork_of_insiders>.git

I'm running the docs build on netlify. The newtlify config file looks like this:

[build]
publish = "site"
command = """
pip3 install --no-cache-dir -r requirements.txt &&
mkdocs build -f mkdocs-4.8.yml &&
....
mkdocs build -f mkdocs-pt-BR-4.8.yml
"""
[[headers]]
  for = "/*"
  [headers.values]
    X-Frame-Options = "DENY"
    X-Content-Type-Options = "nosniff"
    Strict-Transport-Security = "max-age=63072000; includeSubDomains"

It looks like Netlify installs evertyhing but returns the following error in the end:

2:43:52 AM: ERROR   -  Config value "plugins": The "optimize" plugin is not installed

Did someone face with the same problem? What am I doing wrong?

[alexvoss]

I note that you have mkdocs-material[imaging] in your requirements before the line that is meant to install the insiders edition. I am no wizard with pip but if it installs things one-by-one then it will install the public mkdocs-material before coming to Insiders. Have a look at your logs, you may find that it says that the dependency mkdocs-material is already fulfilled. The solution, then, would be to switch the order of the two lines. Hope this helps.

[AnastasiaTWW]

Thank for your reply! I tried to re-order things but it did not help :( The same error

[alexvoss]

Can you get a log file that shows what actually happens? It could be that your token is not set or is invalid. Whatever it is, it would seem that you end up running the public version of Material.

[kamilkrzyskow]

Hello,
using your example requirements.txt (changing of course the URL to Insiders) on Windows, pip reported with:

INFO: pip is looking at multiple versions of mkdocs-material[imaging] to determine which version is compatible with other requirements. This could take a while.
Collecting mkdocs-material[imaging] (from -r requirements.txt (line 10))
Obtaining dependency information for mkdocs-material[imaging] from https://files.pythonhosted.org/packages/a0/06/48127f4ba9cea7c0ccb8a63f8db7c4323caca1301ee42490a636215a87a6/mkdocs_material-9.4.13-py3-none-any.whl.metadata
Downloading mkdocs_material-9.4.13-py3-none-any.whl.metadata (16 kB)
Obtaining dependency information for mkdocs-material[imaging] from https://files.pythonhosted.org/packages/85/9a/e8b05e18c51c528dc91837568eac7fa198ecaa89e4480b9361ac6a676dbe/mkdocs_material-9.4.12-py3-none-any.whl.metadata
  ...

"This could take a while" is too long for me, so I changed the entry to mkdocs-material[imaging]==9.4.14 and pip reported with:

ERROR: Cannot install mkdocs-material 9.4.14+insiders.4.46.0 (from git+https://github.com/...) and mkdocs-material[imaging]==9.4.14 because these package versions have conflicting dependencies.

The conflict is caused by:
    The user requested mkdocs-material 9.4.14+insiders.4.46.0 (from git+https://github.com/...)
    mkdocs-material[imaging] 9.4.14 depends on mkdocs-material 9.4.14 (from https://files.pythonhosted.org/packages/34/31/98fff7fe1401cf8c45127d836cd34b6d512a5e984f2f4dc3cbb17aad8674/mkdocs_material-9.4.14-py3-none-any.whl (from https://pypi.org/simple/mkdocs-material/) (requires-python:>=3.8))

To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict

ERROR: ResolutionImpossible: for help visit https://pip.pypa.io/en/latest/topics/dependency-resolution/#dealing-with-dependency-conflicts

Therefore it seems that there is some sort of conflict with those 2 packages 🤔. The Netlify guide for Insiders also instructs to only use the Insiders version: https://www.starfallprojects.co.uk/projects/deploy-host-docs/deploy-mkdocs-material-netlify/

The imaging extra consists of 2 packages, and all other dependency module versions can be managed by the theme, therefore we could simplify the requirements.txt to:

git+https://${CLONE_INSIDERS_TOKEN}:x-oauth-basic@github.com/<private_fork_of_insiders>.git
pillow==10.1.0
cairosvg==2.7.1
mkdocs-minify-plugin==0.7.1
# Don't know what prependnewline is, so I left it
prependnewline==1.2
mkdocs-meta-descriptions-plugin==3.0.0
# Oddly specific requirement of importlib, so I left it
importlib_metadata==7.0.0
mkdocs-glightbox==0.3.5

mkdocs-material/pyproject.toml

Lines 65 to 68 in 560bb90

	imaging = [
	"pillow~=9.4",
	"cairosvg~=2.6"
	]

This allowed me to successfully install it with pip.

---

As for the other matter of using Netlify and probably a Linux Docker image, I explained some debugging methods for packages in another discussion: mkdocs/mkdocs#3492

[AnastasiaTWW]

I've just run several documentation builds and seems that the problem disappeared! Thank you all for your help and responsiveness! I hope that it will work stable but if the error comes again, I will let you know

[AnastasiaTWW]

Hi all! Coming back to this thread as again I have the issue with the image optimization plugin. It occurred once I have updated mkdocs insiders up to 4.53.8 version.

4:37:03 PM: INFO    -  Building documentation to directory: /opt/build/repo/site/3.6
4:37:08 PM: Traceback (most recent call last):
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/structure/files.py", line 109, in remove
4:37:08 PM:     del self._src_uris[file.src_uri]
4:37:08 PM: KeyError: '.cache/plugin/optimize/images/installation-azure/auto-scaling/ru/load-balancing-guide/add-balancing-rule.png'
4:37:08 PM: During handling of the above exception, another exception occurred:
4:37:08 PM: Traceback (most recent call last):
4:37:08 PM:   File "/opt/buildhome/python3.8/bin/mkdocs", line 8, in <module>
4:37:08 PM:     sys.exit(cli())
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 1157, in __call__
4:37:08 PM:     return self.main(*args, **kwargs)
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 1078, in main
4:37:08 PM:     rv = self.invoke(ctx)
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 1688, in invoke
4:37:08 PM:     return _process_result(sub_ctx.command.invoke(sub_ctx))
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 1434, in invoke
4:37:08 PM:     return ctx.invoke(self.callback, **ctx.params)
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 783, in invoke
4:37:08 PM:     return __callback(*args, **kwargs)
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/__main__.py", line 284, in build_command
4:37:08 PM:     build.build(cfg, dirty=not clean)
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/commands/build.py", line 319, in build
4:37:08 PM:     env = config.plugins.on_env(env, config=config, files=files)
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/plugins.py", line 599, in on_env
4:37:08 PM:     return self.run_event('env', env, config=config, files=files)
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/plugins.py", line 566, in run_event
4:37:08 PM:     result = method(item, **kwargs)
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/material/plugins/optimize/plugin.py", line 131, in on_env
4:37:08 PM:     files.remove(file)
4:37:08 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/structure/files.py", line 111, in remove
4:37:08 PM:     raise ValueError(f'{file.src_uri!r} not in collection')
4:37:08 PM: ValueError: '.cache/plugin/optimize/images/installation-azure/auto-scaling/ru/load-balancing-guide/add-balancing-rule.png' not in collection

Do you have an idea what is wrong?

Other deps are the following:

git+https://${CLONE_INSIDERS_TOKEN}:x-oauth-basic@github.com/wallarm/mkdocs-material-insiders.git
pymdown-extensions==10.7
pygments==2.17.2
mkdocs-minify-plugin==0.7.1
prependnewline==1.2
mkdocs-meta-descriptions-plugin==3.0.0
markdown==3.5.2
importlib_metadata==7.0.1
mkdocs-glightbox==0.3.7
pillow==10.3.0
cairosvg==2.7.1

[squidfunk]

If you could provide a minimal reproduction, we're happy to look into it!

[AnastasiaTWW]

The thing is that, again, I cannot get the same error in the minimal reproduction. And generally this error seems to be floating. BTW, I quess it is again connected with the Pythin version (we use 3.8 and cannot migrate to the newer one right now as this is the limitation of Netlify). We have ~150 images to be optimized and we have several documentation versions (10). Versioning is implemented with our custom script. Images are optimized only during the build of the newest version. In all other versions of the documentation, we use symbolic links to the images from the newest version.

[squidfunk]

Hmm, yeah, I understand that it's hard to track down, but if there's nothing we can observe, it's hard for us to fix 😅

[AnastasiaTWW]

Thanks everyone for the help! CLosing the issues - the problem has been caused by Netlify limitations

[squidfunk]

I've marked @kamilkrzyskow comment as the answer, because the initial problem was concerning dependencies. The problem with the optimize plugin not finding pngquant is a subsequent problem.