mkdocs serve fails after upgrade

[holgerflick]

Hi everybody,

ok, I admit it, I took a long time to update my page, but I have been busy with other stuff and I have not run mkdocs serve since May. So, today I updated to the latest insider build and ran mkdocs serve.

All I get is a long list of errors I cannot make any sense of. Any hint where I made a mistake?

INFO    -  Building documentation...
INFO    -  Cleaning site directory
Traceback (most recent call last):
  File "/Library/Frameworks/Python.framework/Versions/3.11/bin/mkdocs", line 8, in <module>
    sys.exit(cli())
             ^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/click/core.py", line 829, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/mkdocs/__main__.py", line 268, in serve_command
    serve.serve(**kwargs)
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/mkdocs/commands/serve.py", line 85, in serve
    builder(config)
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/mkdocs/commands/serve.py", line 67, in builder
    build(config, serve_url=None if is_clean else serve_url, dirty=is_dirty)
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/mkdocs/commands/build.py", line 328, in build
    _build_theme_template(template, env, files, config, nav)
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/mkdocs/commands/build.py", line 103, in _build_theme_template
    output = _build_template(template_name, template, files, config, nav)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/mkdocs/commands/build.py", line 83, in _build_template
    output = template.render(context)
             ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/jinja2/environment.py", line 1301, in render
    self.environment.handle_exception()
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/jinja2/environment.py", line 936, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/material/templates/404.html", line 4, in top-level template code
    {% extends "main.html" %}
  File "/Users/holger/docs/holgerscode/overrides/main.html", line 1, in top-level template code
    {% extends "base.html" %}
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/material/templates/base.html", line 51, in top-level template code
    {% block styles %}
^^^^^^^^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/material/templates/base.html", line 57, in block 'styles'
    {% include "partials/icons.html" %}
^^^^^^^^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/material/templates/partials/icons.html", line 33, in top-level template code
    {% import ".icons/" ~ icon ~ ".svg" as icon %}
^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/site-packages/jinja2/loaders.py", line 204, in get_source
    raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: .icons/simple/windows11.svg

[kamilkrzyskow]

Hello @holgerflick,
looking at the error as-is, you're using the simple/windows11 icon somewhere in your docs, possibly as a page icon.
After looking closely at the Traceback it shows the line number of the error:

• mkdocs-material/material/templates/partials/icons.html

  Lines 30 to 33 in 8ff76b0

  	{% if config.theme.icon.tag %}
  	{% set style = ["\x3cstyle\x3e"] %}
  	{% for type, icon in config.theme.icon.tag.items() %}
  	{% import ".icons/" ~ icon ~ ".svg" as icon %}

So you're using a custom icon for tags config.theme.icon.tag? At least that's how I read it.

IIRC simple icons have removed Microsoft-based icons from their latest releases due to legal licensing issues.
So as a quick fix, I would go over the usages of simple icons in your docs and remove anything Windows / Microsoft related.
If you want a better fix, you could extend the theme with your own copies of those icons.

Reference:

• https://github.com/simple-icons/simple-icons/releases/tag/13.0.0
• Remove Microsoft brands simple-icons/simple-icons#10019
• Last mkdocs-material version with simple icons <13 was 9.5.27

  mkdocs-material/package.json

  Line 89 in 845fc61

  "simple-icons": "^12.4.0",

[holgerflick]

Thanks for your help. The sheer amount of error messages with Python still overwhelm me. That was the cause indeed.