build and serve failure with newest insiders - mkdocs-material-9.0.6-insiders-4.28.1

[olliestrickland]

I can successfully serve and build with base material, however I cannot with the new release of insiders 9.0.6.

Anyone else having an issue?

Thanks

Here is the output:

INFO     -  Building documentation...
INFO     -  [macros] - Macros arguments: {'module_name': 'main', 'modules': [], 'include_dir': 'docs/assets/include/snippets/', 'include_yaml': [], 'j2_block_start_string': '', 'j2_block_end_string': '',
            'j2_variable_start_string': '', 'j2_variable_end_string': '', 'on_undefined': 'keep', 'on_error_fail': False, 'verbose': False}
INFO     -  [macros] - Extra variables (config file): ['generator', 'social']
INFO     -  [macros] - Extra filters (module): ['pretty']
INFO     -  [macros] - Includes directory: docs/assets/include/snippets/
INFO     -  Cleaning site directory
INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
              - careers.md
              - privacy.md
              - assets/include/glossary.md
              - assets/include/career-ops/2022-03-junior-sa.md
              - landing/error.md
              - landing/success.md
Traceback (most recent call last):
  File "/home/ollie/.local/bin/mkdocs", line 8, in <module>
    sys.exit(cli())
  File "/home/ollie/.local/lib/python3.10/site-packages/click/core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
  File "/home/ollie/.local/lib/python3.10/site-packages/click/core.py", line 1055, in main
    rv = self.invoke(ctx)
  File "/home/ollie/.local/lib/python3.10/site-packages/click/core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/ollie/.local/lib/python3.10/site-packages/click/core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/ollie/.local/lib/python3.10/site-packages/click/core.py", line 760, in invoke
    return __callback(*args, **kwargs)
  File "/home/ollie/.local/lib/python3.10/site-packages/mkdocs/__main__.py", line 234, in serve_command
    serve.serve(dev_addr=dev_addr, livereload=livereload, watch=watch, **kwargs)
  File "/home/ollie/.local/lib/python3.10/site-packages/mkdocs/commands/serve.py", line 83, in serve
    builder(config)
  File "/home/ollie/.local/lib/python3.10/site-packages/mkdocs/commands/serve.py", line 76, in builder
    build(config, live_server=live_server, dirty=dirty)
  File "/home/ollie/.local/lib/python3.10/site-packages/mkdocs/commands/build.py", line 320, in build
    _build_theme_template(template, env, files, config, nav)
  File "/home/ollie/.local/lib/python3.10/site-packages/mkdocs/commands/build.py", line 118, in _build_theme_template
    output = _build_template(template_name, template, files, config, nav)
  File "/home/ollie/.local/lib/python3.10/site-packages/mkdocs/commands/build.py", line 97, in _build_template
    output = template.render(context)
  File "/home/ollie/.local/lib/python3.10/site-packages/jinja2/environment.py", line 1301, in render
    self.environment.handle_exception()
  File "/home/ollie/.local/lib/python3.10/site-packages/jinja2/environment.py", line 936, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "/mnt/c/users/ollie/desktop/bitstream-site/docs/assets/overrides/404.html", line 1, in top-level template code
    {% extends "main.html" %}
  File "/mnt/c/users/ollie/desktop/bitstream-site/docs/assets/overrides/main.html", line 1, in top-level template code
    {% extends "base.html" %}
  File "/home/ollie/.local/lib/python3.10/site-packages/material/base.html", line 145, in top-level template code
    {% block tabs %}
  File "/home/ollie/.local/lib/python3.10/site-packages/material/base.html", line 148, in block 'tabs'
    {% include "partials/tabs.html" %}
  File "/home/ollie/.local/lib/python3.10/site-packages/material/partials/tabs.html", line 4, in top-level template code
    {% import "partials/tabs-item.html" as item with context %}
  File "/home/ollie/.local/lib/python3.10/site-packages/jinja2/environment.py", line 1405, in make_module
    return TemplateModule(self, ctx)
  File "/home/ollie/.local/lib/python3.10/site-packages/jinja2/environment.py", line 1535, in __init__
    body_stream = list(template.root_render_func(context))  # type: ignore
  File "/mnt/c/users/ollie/desktop/bitstream-site/docs/assets/overrides/partials/tabs-item.html", line 26, in top-level template code
    {% if nav_item.active %}
  File "/home/ollie/.local/lib/python3.10/site-packages/jinja2/environment.py", line 485, in getattr
    return getattr(obj, attribute)
jinja2.exceptions.UndefinedError: 'nav_item' is undefined

[olliestrickland]

A couple more facts:

1 - things work if I roll back to 9.0.4-insiders-4.27.1
2 - it's related to /material/partials/tabs-item.html - maybe from commit 986d60d

[olliestrickland]

So I guess since this build error is the result of an override, it falls into customization land and we need to start over on this override with the new source file as our starting point...

[squidfunk]

So first of all, sorry for the troubles this is causing. However, please understand that we need to change templates sometimes to keep things in good shape and/or add new functionality. In this case, two templates might need to be adjusted: tabs.html and tabs-item.html – click the link to see the diff. Essentially, tabs-item.html now exports a macro, which is used in tabs.html. This is more performant than the previous repetitive includes, as the cost of importing only have to be paid once.

This should be solvable in a matter of minutes. If not, please reach out again.

[olliestrickland]

Yes, I believe I have my mind wrapped around it now; we will reconstruct based on the new templates.

Thank you sir.

[squidfunk]

Great! If you run into any problems, don't hesitate to reach out again. We're working on a solution that will make template upgrades easier by providing the exact diffs based on your version vs. the latest version. This is already possible on GitHub, but the UI/UX is a little more complicated that it might need to be.