Tags - Listing

[XtremeOwnageDotCom]

Description

Attempting to get everything updated on my site to the latest round of changes from insiders-

And, I have been running into issues trying to update this page: https://static.xtremeownage.com/pages/tags/

Previously, it just used [TAGS], which magically produced the listing.

After poking around a bit with the current documentation, realizing #6556 is also in progress- I have ran into issues trying to replicate this page.

My assumption, is I create a listing, however, I am running into issues getting it to display anything.

Just- looking for a few pointers.

What I have tried-

<!-- material/tags -->

Produces a stack dump.

Traceback (most recent call last):
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\mkdocs\livereload\__init__.py", line 193, in _build_loop
    func()
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\serve.py", line 67, in builder
    build(config, live_server=None if is_clean else server, dirty=is_dirty)
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\mkdocs\commands\build.py", line 331, in build
    env = config.plugins.on_env(env, config=config, files=files)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\mkdocs\plugins.py", line 539, in on_env
    return self.run_event('env', env, config=config, files=files)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\mkdocs\plugins.py", line 507, in run_event
    result = method(item, **kwargs)
             ^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\material\plugins\tags\plugin.py", line 197, in on_env
    self.listings.populate_all(self.mappings, Renderer(env, config))
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\material\plugins\tags\structure\listing\manager\__init__.py", line 316, in populate_all
    self.populate(listing, mappings, renderer)
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\material\plugins\tags\structure\listing\manager\__init__.py", line 250, in populate
    tree.content = renderer.render(page, name, tag = tree.tag)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\material\plugins\tags\renderer\__init__.py", line 88, in render
    template = self.env.get_template(f"fragments/tags/{name}")
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\jinja2\environment.py", line 1010, in get_template
    return self._load_template(name, globals)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\jinja2\environment.py", line 969, in _load_template
    template = self.loader.load(self, name, self.make_globals(globals))
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\jinja2\loaders.py", line 125, in load
    source, filename, uptodate = self.get_source(environment, name)
                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\jinja2\loaders.py", line 194, in get_source
    pieces = split_template_path(template)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\Eric\AppData\Roaming\Python\Python311\site-packages\jinja2\loaders.py", line 35, in split_template_path
    raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: fragments/tags/default\tag.html
ERROR   -  [14:25:21] An error happened during the rebuild. The server will appear stuck until build errors are resolved.

<!-- material/tags { scope: false } -->

Produces an empty page.

<!-- material/tags { scope: true} -->

Produces an empty page.

Before submitting

• I have read and followed the documentation issue guidelines.
• I have attached the links to the affected sections of the documentation

[squidfunk]

Thanks for reporting. Unfortunately, you did not provide all necessary information for us, so we can only guess. We invested a lot of time into our bug reporting guidelines for a reason – we need complete information to help you. However, from the stack trace posted, we can try to guess: there seems to be a path issue with Windows.

Additionally, please don't misuse our issue templates – you've reported a bug with the documentation template. That is not intended as you're providing us with incomplete information.

[squidfunk]

Please try the latest master of Insiders, as e93b4b7 is an attempt to fix the issue with the information that we have.

[squidfunk]

@kamilkrzyskow I'm not sure I understand your last comment – did you find a fix?

[kamilkrzyskow]

I've created a PR https://github.com/squidfunk/mkdocs-material-insiders/pull/80 @squidfunk
Also as a side note I feel like in general fragments/tags/default\tag.html is a valid path in Windows, though I didn't test it hehe
I don't know about ancient Windows versions but Windows 8 / 10 / 11 should easily process posix paths, so maybe instead of using os.path you could use posixpath in the future, as a "just to be sure" approach 😅

[squidfunk]

Awesome, https://github.com/squidfunk/mkdocs-material-insiders/pull/80 was merged

@XtremeOwnageDotCom can you check if this fixes the error on your side?

[XtremeOwnageDotCom]

@squidfunk

Updated my branch.

Updated / Built / etc.....

And- it works as I was expecting.

Also-

Additionally, please don't misuse our issue templates – you've reported a bug with the documentation template. That is not intended as you're providing us with incomplete information.

Opened as documentation, because I was assuming the issue was on my end, and I was unable to determine if it was due to misconfiguration / etc, as the documentation didn't have enough details for me to determine this.

Thanks for the assistance. Appears the bug was identified, and corrected.

[squidfunk]

Released as part of 9.5.6+insiders-4.52.1.