Add files using upload-large-folder tool

micromamba_root/Lib/site-packages/material/plugins/blog/__init__.py

@@ -0,0 +1,33 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from .structure import View
+
+# -----------------------------------------------------------------------------
+# Functions
+# -----------------------------------------------------------------------------
+
+# Sort views by name
+def view_name(view: View):
+    return view.name
+
+# Sort views by post count
+def view_post_count(view: View):
+    return len(view.posts)

micromamba_root/Lib/site-packages/material/plugins/blog/author.py

@@ -0,0 +1,40 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from mkdocs.config.base import Config
+from mkdocs.config.config_options import DictOfItems, Optional, SubConfig, Type
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Author
+class Author(Config):
+    name = Type(str)
+    description = Type(str)
+    avatar = Type(str)
+    slug = Optional(Type(str))
+    url = Optional(Type(str))
+
+# -----------------------------------------------------------------------------
+
+# Authors
+class Authors(Config):
+    authors = DictOfItems(SubConfig(Author), default = {})

micromamba_root/Lib/site-packages/material/plugins/blog/config.py

@@ -0,0 +1,102 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from collections.abc import Callable
+from mkdocs.config.config_options import Choice, Deprecated, Optional, Type
+from mkdocs.config.base import Config
+from pymdownx.slugs import slugify
+
+from . import view_name
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Blog plugin configuration
+class BlogConfig(Config):
+    enabled = Type(bool, default = True)
+
+    # Settings for blog
+    blog_dir = Type(str, default = "blog")
+    blog_toc = Type(bool, default = False)
+
+    # Settings for posts
+    post_dir = Type(str, default = "{blog}/posts")
+    post_date_format = Type(str, default = "long")
+    post_url_date_format = Type(str, default = "yyyy/MM/dd")
+    post_url_format = Type(str, default = "{date}/{slug}")
+    post_url_max_categories = Type(int, default = 1)
+    post_slugify = Type(Callable, default = slugify(case = "lower"))
+    post_slugify_separator = Type(str, default = "-")
+    post_excerpt = Choice(["optional", "required"], default = "optional")
+    post_excerpt_max_authors = Type(int, default = 1)
+    post_excerpt_max_categories = Type(int, default = 5)
+    post_excerpt_separator = Type(str, default = "<!-- more -->")
+    post_readtime = Type(bool, default = True)
+    post_readtime_words_per_minute = Type(int, default = 265)
+
+    # Settings for archive
+    archive = Type(bool, default = True)
+    archive_name = Type(str, default = "blog.archive")
+    archive_date_format = Type(str, default = "yyyy")
+    archive_url_date_format = Type(str, default = "yyyy")
+    archive_url_format = Type(str, default = "archive/{date}")
+    archive_pagination = Optional(Type(bool))
+    archive_pagination_per_page = Optional(Type(int))
+    archive_toc = Optional(Type(bool))
+
+    # Settings for categories
+    categories = Type(bool, default = True)
+    categories_name = Type(str, default = "blog.categories")
+    categories_url_format = Type(str, default = "category/{slug}")
+    categories_slugify = Type(Callable, default = slugify(case = "lower"))
+    categories_slugify_separator = Type(str, default = "-")
+    categories_sort_by = Type(Callable, default = view_name)
+    categories_sort_reverse = Type(bool, default = False)
+    categories_allowed = Type(list, default = [])
+    categories_pagination = Optional(Type(bool))
+    categories_pagination_per_page = Optional(Type(int))
+    categories_toc = Optional(Type(bool))
+
+    # Settings for authors
+    authors = Type(bool, default = True)
+    authors_file = Type(str, default = "{blog}/.authors.yml")
+    authors_profiles = Type(bool, default = False)
+    authors_profiles_name = Type(str, default = "blog.authors")
+    authors_profiles_url_format = Type(str, default = "author/{slug}")
+    authors_profiles_pagination = Optional(Type(bool))
+    authors_profiles_pagination_per_page = Optional(Type(int))
+    authors_profiles_toc = Optional(Type(bool))
+
+    # Settings for pagination
+    pagination = Type(bool, default = True)
+    pagination_per_page = Type(int, default = 10)
+    pagination_url_format = Type(str, default = "page/{page}")
+    pagination_format = Type(str, default = "~2~")
+    pagination_if_single_page = Type(bool, default = False)
+    pagination_keep_content = Type(bool, default = False)
+
+    # Settings for drafts
+    draft = Type(bool, default = False)
+    draft_on_serve = Type(bool, default = True)
+    draft_if_future_date = Type(bool, default = False)
+
+    # Deprecated settings
+    pagination_template = Deprecated(moved_to = "pagination_format")

micromamba_root/Lib/site-packages/material/plugins/blog/plugin.py

@@ -0,0 +1,1083 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from __future__ import annotations
+
+import logging
+import os
+import posixpath
+import yaml
+
+from babel.dates import format_date, format_datetime
+from copy import copy
+from datetime import datetime, timezone
+from jinja2 import pass_context
+from jinja2.runtime import Context
+from mkdocs.config.defaults import MkDocsConfig
+from mkdocs.exceptions import PluginError
+from mkdocs.plugins import BasePlugin, event_priority
+from mkdocs.structure import StructureItem
+from mkdocs.structure.files import File, Files, InclusionLevel
+from mkdocs.structure.nav import Link, Navigation, Section
+from mkdocs.structure.pages import Page
+from mkdocs.structure.toc import AnchorLink, TableOfContents
+from mkdocs.utils import copy_file, get_relative_url
+from paginate import Page as Pagination
+from shutil import rmtree
+from tempfile import mkdtemp
+from urllib.parse import urlparse
+from yaml import SafeLoader
+
+from . import view_name
+from .author import Author, Authors
+from .config import BlogConfig
+from .readtime import readtime
+from .structure import (
+  Archive, Category, Profile,
+  Excerpt, Post, View,
+  Reference
+)
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Blog plugin
+class BlogPlugin(BasePlugin[BlogConfig]):
+    supports_multiple_instances = True
+
+    # Initialize plugin
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # Initialize incremental builds
+        self.is_serve = False
+        self.is_dirty = False
+
+        # Initialize temporary directory
+        self.temp_dir = mkdtemp()
+
+    # Determine whether we're serving the site
+    def on_startup(self, *, command, dirty):
+        self.is_serve = command == "serve"
+        self.is_dirty = dirty
+
+    # Initialize authors and set defaults
+    def on_config(self, config):
+        if not self.config.enabled:
+            return
+
+        # Initialize entrypoint
+        self.blog: View
+
+        # Initialize and resolve authors, if enabled
+        if self.config.authors:
+            self.authors = self._resolve_authors(config)
+
+        # By default, drafts are rendered when the documentation is served,
+        # but not when it is built, for a better user experience
+        if self.is_serve and self.config.draft_on_serve:
+            self.config.draft = True
+
+    # Resolve and load posts and generate views (run later) - we want to allow
+    # other plugins to add generated posts or views, so we run this plugin as
+    # late as possible. We also need to remove the posts from the navigation
+    # before navigation is constructed, as the entrypoint should be considered
+    # to be the active page for each post. The URLs of posts are computed before
+    # Markdown processing, so that when linking to and from posts, behavior is
+    # exactly the same as with regular documentation pages. We create all pages
+    # related to posts as part of this plugin, so we control the entire process.
+    @event_priority(-50)
+    def on_files(self, files, *, config):
+        if not self.config.enabled:
+            return
+
+        # Resolve path to entrypoint and site directory
+        root = posixpath.normpath(self.config.blog_dir)
+        site = config.site_dir
+
+        # Compute and normalize path to posts directory
+        path = self.config.post_dir.format(blog = root)
+        path = posixpath.normpath(path)
+
+        # Adjust destination paths for media files
+        for file in files.media_files():
+            if not file.src_uri.startswith(path):
+                continue
+
+            # We need to adjust destination paths for assets to remove the
+            # purely functional posts directory prefix when building
+            file.dest_uri      = file.dest_uri.replace(path, root)
+            file.abs_dest_path = os.path.join(site, file.dest_path)
+            file.url           = file.url.replace(path, root)
+
+        # Resolve entrypoint and posts sorted by descending date - if the posts
+        # directory or entrypoint do not exist, they are automatically created
+        self.blog = self._resolve(files, config)
+        self.blog.posts = sorted(
+            self._resolve_posts(files, config),
+            key = lambda post: (
+                post.config.pin,
+                post.config.date.created
+            ),
+            reverse = True
+        )
+
+        # Generate views for archive
+        if self.config.archive:
+            views = self._generate_archive(config, files)
+            self.blog.views.extend(views)
+
+        # Generate views for categories
+        if self.config.categories:
+            views = self._generate_categories(config, files)
+
+            # We always sort the list of categories by name first, so that any
+            # custom sorting function that returns the same value for two items
+            # returns them in a predictable and logical order, because sorting
+            # in Python is stable, i.e., order of equal items is preserved
+            self.blog.views.extend(sorted(
+                sorted(views, key = view_name),
+                key     = self.config.categories_sort_by,
+                reverse = self.config.categories_sort_reverse
+            ))
+
+        # Generate views for profiles
+        if self.config.authors_profiles:
+            views = self._generate_profiles(config, files)
+            self.blog.views.extend(views)
+
+        # Generate pages for views
+        for view in self._resolve_views(self.blog):
+            if self._config_pagination(view):
+                for page in self._generate_pages(view, config, files):
+                    view.pages.append(page)
+
+        # Ensure that entrypoint is always included in navigation
+        self.blog.file.inclusion = InclusionLevel.INCLUDED
+
+    # Attach posts and views to navigation (run later) - again, we allow other
+    # plugins to alter the navigation before we start to attach posts and views
+    # generated by this plugin at the correct locations in the navigation. Also,
+    # we make sure to correct links to the parent and siblings of each page.
+    @event_priority(-50)
+    def on_nav(self, nav, *, config, files):
+        if not self.config.enabled:
+            return
+
+        # If we're not building a standalone blog, the entrypoint will always
+        # have a parent when it is included in the navigation. The parent is
+        # essential to correctly resolve the location where the archive and
+        # category views are attached. If the entrypoint doesn't have a parent,
+        # we know that the author did not include it in the navigation, so we
+        # explicitly mark it as not included.
+        if not self.blog.parent and self.config.blog_dir != ".":
+            self.blog.file.inclusion = InclusionLevel.NOT_IN_NAV
+
+        # Attach posts to entrypoint without adding them to the navigation, so
+        # that the entrypoint is considered to be the active page for each post
+        self._attach(self.blog, [None, *reversed(self.blog.posts), None])
+        for post in self.blog.posts:
+            post.file.inclusion = InclusionLevel.NOT_IN_NAV
+
+        # Revert temporary exclusion of views from navigation
+        for view in self._resolve_views(self.blog):
+            view.file.inclusion = self.blog.file.inclusion
+            for page in view.pages:
+                page.file.inclusion = self.blog.file.inclusion
+
+        # Attach views for archive
+        if self.config.archive:
+            title = self._translate(self.config.archive_name, config)
+            views = [_ for _ in self.blog.views if isinstance(_, Archive)]
+
+            # Attach and link views for archive
+            if self.blog.file.inclusion.is_in_nav():
+                self._attach_to(self.blog, Section(title, views), nav)
+
+        # Attach views for categories
+        if self.config.categories:
+            title = self._translate(self.config.categories_name, config)
+            views = [_ for _ in self.blog.views if isinstance(_, Category)]
+
+            # Attach and link views for categories, if any
+            if self.blog.file.inclusion.is_in_nav() and views:
+                self._attach_to(self.blog, Section(title, views), nav)
+
+        # Attach views for profiles
+        if self.config.authors_profiles:
+            title = self._translate(self.config.authors_profiles_name, config)
+            views = [_ for _ in self.blog.views if isinstance(_, Profile)]
+
+            # Attach and link views for categories, if any
+            if self.blog.file.inclusion.is_in_nav() and views:
+                self._attach_to(self.blog, Section(title, views), nav)
+
+        # Attach pages for views
+        for view in self._resolve_views(self.blog):
+            if self._config_pagination(view):
+                for at in range(1, len(view.pages)):
+                    self._attach_at(view.parent, view, view.pages[at])
+
+    # Prepare post for rendering (run later) - allow other plugins to alter
+    # the contents or metadata of a post before it is rendered and make sure
+    # that the post includes a separator, which is essential for rendering
+    # excerpts that should be included in views
+    @event_priority(-50)
+    def on_page_markdown(self, markdown, *, page, config, files):
+        if not self.config.enabled:
+            return
+
+        # Skip if page is not a post managed by this instance - this plugin has
+        # support for multiple instances, which is why this check is necessary
+        if page not in self.blog.posts:
+            if not self._config_pagination(page):
+                return
+
+            # We set the contents of the view to its title if pagination should
+            # not keep the content of the original view on paginated views
+            if not self.config.pagination_keep_content:
+                view = self._resolve_original(page)
+                if view in self._resolve_views(self.blog):
+
+                    # If the current view is paginated, use the rendered title
+                    # of the original view in case the author set the title in
+                    # the page's contents, or it would be overridden with the
+                    # one set in mkdocs.yml, leading to inconsistent headings
+                    assert isinstance(view, View)
+                    if view != page:
+                        name = view._title_from_render or view.title
+                        return f"# {name}"
+
+            # Nothing more to be done for views
+            return
+
+        # Extract and assign authors to post, if enabled
+        if self.config.authors:
+            for id in page.config.authors:
+                if id not in self.authors:
+                    raise PluginError(f"Couldn't find author '{id}'")
+
+                # Append to list of authors
+                page.authors.append(self.authors[id])
+
+        # Extract settings for excerpts
+        separator      = self.config.post_excerpt_separator
+        max_authors    = self.config.post_excerpt_max_authors
+        max_categories = self.config.post_excerpt_max_categories
+
+        # Ensure presence of separator and throw, if its absent and required -
+        # we append the separator to the end of the contents of the post, if it
+        # is not already present, so we can remove footnotes or other content
+        # from the excerpt without affecting the content of the excerpt
+        if separator not in page.markdown:
+            if self.config.post_excerpt == "required":
+                docs = os.path.relpath(config.docs_dir)
+                path = os.path.relpath(page.file.abs_src_path, docs)
+                raise PluginError(
+                    f"Couldn't find '{separator}' in post '{path}' in '{docs}'"
+                )
+
+        # Create excerpt for post and inherit authors and categories - excerpts
+        # can contain a subset of the authors and categories of the post
+        page.excerpt            = Excerpt(page, config, files)
+        page.excerpt.authors    = page.authors[:max_authors]
+        page.excerpt.categories = page.categories[:max_categories]
+
+    # Process posts
+    def on_page_content(self, html, *, page, config, files):
+        if not self.config.enabled:
+            return
+
+        # Skip if page is not a post managed by this instance - this plugin has
+        # support for multiple instances, which is why this check is necessary
+        if page not in self.blog.posts:
+            return
+
+        # Compute readtime of post, if enabled and not explicitly set
+        if self.config.post_readtime:
+            words_per_minute = self.config.post_readtime_words_per_minute
+            if not page.config.readtime:
+                page.config.readtime = readtime(html, words_per_minute)
+
+    # Register template filters for plugin
+    def on_env(self, env, *, config, files):
+        if not self.config.enabled:
+            return
+
+        # Transform links to point to posts and pages
+        for post in self.blog.posts:
+            self._generate_links(post, config, files)
+
+        # Filter for formatting dates related to posts
+        def date_filter(date: datetime):
+            return self._format_date_for_post(date, config)
+
+        # Fetch URL template filter from environment - the filter might
+        # be overridden by other plugins, so we must retrieve and wrap it
+        url_filter = env.filters["url"]
+
+        # Patch URL template filter to add support for paginated views, i.e.,
+        # that paginated views never link to themselves but to the main vie
+        @pass_context
+        def url_filter_with_pagination(context: Context, url: str | None):
+            page = context["page"]
+
+            # If the current page is a view, check if the URL links to the page
+            # itself, and replace it with the URL of the main view
+            if isinstance(page, View):
+                view = self._resolve_original(page)
+                if page.url == url:
+                    url = view.url
+
+            # Forward to original template filter
+            return url_filter(context, url)
+
+        # Register custom template filters
+        env.filters["date"] = date_filter
+        env.filters["url"]  = url_filter_with_pagination
+
+    # Prepare view for rendering (run latest) - views are rendered last, as we
+    # need to mutate the navigation to account for pagination. The main problem
+    # is that we need to replace the view in the navigation, because otherwise
+    # the view would not be considered active.
+    @event_priority(-100)
+    def on_page_context(self, context, *, page, config, nav):
+        if not self.config.enabled:
+            return
+
+        # Skip if page is not a view managed by this instance - this plugin has
+        # support for multiple instances, which is why this check is necessary
+        view = self._resolve_original(page)
+        if view not in self._resolve_views(self.blog):
+            return
+
+        # Render excerpts and prepare pagination
+        posts, pagination = self._render(page)
+
+        # Render pagination links
+        def pager(args: object):
+            return pagination.pager(
+                format = self.config.pagination_format,
+                show_if_single_page = self.config.pagination_if_single_page,
+                **args
+            )
+
+        # Assign posts and pagination to context
+        context["posts"]      = posts
+        context["pagination"] = pager if pagination else None
+
+    # Remove temporary directory on shutdown
+    def on_shutdown(self):
+        rmtree(self.temp_dir)
+
+    # -------------------------------------------------------------------------
+
+    # Check if the given post is excluded
+    def _is_excluded(self, post: Post):
+        if self.config.draft:
+            return False
+
+        # If a post was not explicitly marked or unmarked as draft, and the
+        # date should be taken into account, we automatically mark it as draft
+        # if the publishing date is in the future. This, of course, is opt-in
+        # and must be explicitly enabled by the author.
+        if not isinstance(post.config.draft, bool):
+            if self.config.draft_if_future_date:
+                return post.config.date.created > datetime.now(timezone.utc)
+
+        # Post might be a draft
+        return bool(post.config.draft)
+
+    # -------------------------------------------------------------------------
+
+    # Resolve entrypoint - the entrypoint of the blog must have been created
+    # if it did not exist before, and hosts all posts sorted by descending date
+    def _resolve(self, files: Files, config: MkDocsConfig):
+        path = os.path.join(self.config.blog_dir, "index.md")
+        path = os.path.normpath(path)
+
+        # Create entrypoint, if it does not exist - note that the entrypoint is
+        # created in the docs directory, not in the temporary directory
+        docs = os.path.relpath(config.docs_dir)
+        name = os.path.join(docs, path)
+        if not os.path.isfile(name):
+            file = self._path_to_file(path, config, temp = False)
+            files.append(file)
+
+            # Create file in docs directory
+            self._save_to_file(file.abs_src_path, "# Blog\n\n")
+
+        # Create and return entrypoint
+        file = files.get_file_from_path(path)
+        return View(None, file, config)
+
+    # Resolve post - the caller must make sure that the given file points to an
+    # actual post (and not a page), or behavior might be unpredictable
+    def _resolve_post(self, file: File, config: MkDocsConfig):
+        post = Post(file, config)
+
+        # Compute path and create a temporary file for path resolution
+        path = self._format_path_for_post(post, config)
+        temp = self._path_to_file(path, config, temp = False)
+
+        # Replace destination file system path and URL
+        file.dest_uri      = temp.dest_uri
+        file.abs_dest_path = temp.abs_dest_path
+        file.url           = temp.url
+
+        # Replace canonical URL and return post
+        post._set_canonical_url(config.site_url)
+        return post
+
+    # Resolve posts from directory - traverse all documentation pages and filter
+    # and yield those that are located in the posts directory
+    def _resolve_posts(self, files: Files, config: MkDocsConfig):
+        path = self.config.post_dir.format(blog = self.config.blog_dir)
+        path = os.path.normpath(path)
+
+        # Create posts directory, if it does not exist
+        docs = os.path.relpath(config.docs_dir)
+        name = os.path.join(docs, path)
+        if not os.path.isdir(name):
+            os.makedirs(name, exist_ok = True)
+
+        # Filter posts from pages
+        for file in files.documentation_pages():
+            if not file.src_path.startswith(path):
+                continue
+
+            # Temporarily remove post from navigation
+            file.inclusion = InclusionLevel.EXCLUDED
+
+            # Resolve post - in order to determine whether a post should be
+            # excluded, we must load it and analyze its metadata. All posts
+            # marked as drafts are excluded, except for when the author has
+            # configured drafts to be included in the navigation.
+            post = self._resolve_post(file, config)
+            if not self._is_excluded(post):
+                yield post
+
+    # Resolve authors - check if there's an authors file at the configured
+    # location, and if one was found, load and validate it
+    def _resolve_authors(self, config: MkDocsConfig):
+        path = self.config.authors_file.format(blog = self.config.blog_dir)
+        path = os.path.normpath(path)
+
+        # Resolve path relative to docs directory
+        docs = os.path.relpath(config.docs_dir)
+        file = os.path.join(docs, path)
+
+        # If the authors file does not exist, return here
+        config: Authors = Authors()
+        if not os.path.isfile(file):
+            return config.authors
+
+        # Open file and parse as YAML
+        with open(file, encoding = "utf-8-sig") as f:
+            config.config_file_path = os.path.abspath(file)
+            try:
+                config.load_dict(yaml.load(f, SafeLoader) or {})
+
+            # The authors file could not be loaded because of a syntax error,
+            # which we display to the author with a nice error message
+            except Exception as e:
+                raise PluginError(
+                    f"Error reading authors file '{path}' in '{docs}':\n"
+                    f"{e}"
+                )
+
+        # Validate authors and throw if errors occurred
+        errors, warnings = config.validate()
+        for _, w in warnings:
+            log.warning(w)
+        for _, e in errors:
+            raise PluginError(
+                f"Error reading authors file '{path}' in '{docs}':\n"
+                f"{e}"
+            )
+
+        # Return authors
+        return config.authors
+
+    # Resolve views of the given view in pre-order
+    def _resolve_views(self, view: View):
+        yield view
+
+        # Resolve views recursively
+        for page in view.views:
+            for next in self._resolve_views(page):
+                assert isinstance(next, View)
+                yield next
+
+    # Resolve siblings of a navigation item
+    def _resolve_siblings(self, item: StructureItem, nav: Navigation):
+        if isinstance(item.parent, Section):
+            return item.parent.children
+        else:
+            return nav.items
+
+    # Resolve original page or view (e.g. for paginated views)
+    def _resolve_original(self, page: Page):
+        if isinstance(page, View) and page.pages:
+            return page.pages[0]
+        else:
+            return page
+
+    # -------------------------------------------------------------------------
+
+    # Generate views for archive - analyze posts and generate the necessary
+    # views, taking the date format provided by the author into account
+    def _generate_archive(self, config: MkDocsConfig, files: Files):
+        for post in self.blog.posts:
+            date = post.config.date.created
+
+            # Compute name and path of archive view
+            name = self._format_date_for_archive(date, config)
+            path = self._format_path_for_archive(post, config)
+
+            # Create file for view, if it does not exist
+            file = files.get_file_from_path(path)
+            if not file:
+                file = self._path_to_file(path, config)
+                files.append(file)
+
+                # Create file in temporary directory
+                self._save_to_file(file.abs_src_path, f"# {name}")
+
+            # Temporarily remove view from navigation
+            file.inclusion = InclusionLevel.EXCLUDED
+
+            # Create and yield view
+            if not isinstance(file.page, Archive):
+                yield Archive(name, file, config)
+
+            # Assign post to archive
+            assert isinstance(file.page, Archive)
+            file.page.posts.append(post)
+
+    # Generate views for categories - analyze posts and generate the necessary
+    # views, taking the allowed categories as set by the author into account
+    def _generate_categories(self, config: MkDocsConfig, files: Files):
+        for post in self.blog.posts:
+            for name in post.config.categories:
+                path = self._format_path_for_category(name)
+
+                # Ensure category is in non-empty allow list
+                categories = self.config.categories_allowed or [name]
+                if name not in categories:
+                    docs = os.path.relpath(config.docs_dir)
+                    path = os.path.relpath(post.file.abs_src_path, docs)
+                    raise PluginError(
+                        f"Error reading categories of post '{path}' in "
+                        f"'{docs}': category '{name}' not in allow list"
+                    )
+
+                # Create file for view, if it does not exist
+                file = files.get_file_from_path(path)
+                if not file:
+                    file = self._path_to_file(path, config)
+                    files.append(file)
+
+                    # Create file in temporary directory
+                    self._save_to_file(file.abs_src_path, f"# {name}")
+
+                # Temporarily remove view from navigation
+                file.inclusion = InclusionLevel.EXCLUDED
+
+                # Create and yield view
+                if not isinstance(file.page, Category):
+                    yield Category(name, file, config)
+
+                # Assign post to category and vice versa
+                assert isinstance(file.page, Category)
+                file.page.posts.append(post)
+                post.categories.append(file.page)
+
+    # Generate views for profiles - analyze posts and generate the necessary
+    # views to provide a profile page for each author listing all posts
+    def _generate_profiles(self, config: MkDocsConfig, files: Files):
+        for post in self.blog.posts:
+            for id in post.config.authors:
+                author = self.authors[id]
+                path = self._format_path_for_profile(id, author)
+
+                # Create file for view, if it does not exist
+                file = files.get_file_from_path(path)
+                if not file:
+                    file = self._path_to_file(path, config)
+                    files.append(file)
+
+                    # Create file in temporary directory
+                    self._save_to_file(file.abs_src_path, f"# {author.name}")
+
+                # Temporarily remove view from navigation and assign profile
+                # URL to author, if not explicitly set
+                file.inclusion = InclusionLevel.EXCLUDED
+                if not author.url:
+                    author.url = file.url
+
+                # Create and yield view
+                if not isinstance(file.page, Profile):
+                    yield Profile(author.name, file, config)
+
+                # Assign post to profile
+                assert isinstance(file.page, Profile)
+                file.page.posts.append(post)
+
+    # Generate pages for pagination - analyze view and generate the necessary
+    # pages, creating a chain of views for simple rendering and replacement
+    def _generate_pages(self, view: View, config: MkDocsConfig, files: Files):
+        yield view
+
+        # Compute pagination boundaries and create pages - pages are internally
+        # handled as copies of a view, as they map to the same source location
+        step = self._config_pagination_per_page(view)
+        for at in range(step, len(view.posts), step):
+            path = self._format_path_for_pagination(view, 1 + at // step)
+
+            # Create file for view, if it does not exist
+            file = files.get_file_from_path(path)
+            if not file:
+                file = self._path_to_file(path, config)
+                files.append(file)
+
+                # Copy file to temporary directory
+                copy_file(view.file.abs_src_path, file.abs_src_path)
+
+            # Temporarily remove view from navigation
+            file.inclusion = InclusionLevel.EXCLUDED
+
+            # Create and yield view
+            if not isinstance(file.page, View):
+                yield view.__class__(None, file, config)
+
+            # Assign pages and posts to view
+            assert isinstance(file.page, View)
+            file.page.pages = view.pages
+            file.page.posts = view.posts
+
+    # Generate links from the given post to other posts, pages, and sections -
+    # this can only be done once all posts and pages have been parsed
+    def _generate_links(self, post: Post, config: MkDocsConfig, files: Files):
+        if not post.config.links:
+            return
+
+        # Resolve path relative to docs directory for error reporting
+        docs = os.path.relpath(config.docs_dir)
+        path = os.path.relpath(post.file.abs_src_path, docs)
+
+        # Find all links to pages and replace them with references - while all
+        # internal links are processed, external links remain as they are
+        for link in _find_links(post.config.links.items):
+            url = urlparse(link.url)
+            if url.scheme:
+                continue
+
+            # Resolve file for link, and throw if the file could not be found -
+            # authors can link to other pages, as well as to assets or files of
+            # any kind, but it is essential that the file that is linked to is
+            # found, so errors are actually catched and reported
+            file = files.get_file_from_path(url.path)
+            if not file:
+                log.warning(
+                    f"Error reading metadata of post '{path}' in '{docs}':\n"
+                    f"Couldn't find file for link '{url.path}'"
+                )
+                continue
+
+            # If the file linked to is not a page, but an asset or any other
+            # file, we resolve the destination URL and continue
+            if not isinstance(file.page, Page):
+                link.url = file.url
+                continue
+
+            # Cast link to reference
+            link.__class__ = Reference
+            assert isinstance(link, Reference)
+
+            # Assign page title, URL and metadata to link
+            link.title = link.title or file.page.title
+            link.url   = file.page.url
+            link.meta  = copy(file.page.meta)
+
+            # If the link has no fragment, we can continue - if it does, we
+            # need to find the matching anchor in the table of contents
+            if not url.fragment:
+                continue
+
+            # If we're running under dirty reload, MkDocs will reset all pages,
+            # so it's not possible to resolve anchor links. Thus, the only way
+            # to make this work is to skip the entire process of anchor link
+            # resolution in case of a dirty reload.
+            if self.is_dirty:
+                continue
+
+            # Resolve anchor for fragment, and throw if the anchor could not be
+            # found - authors can link to any anchor in the table of contents
+            anchor = _find_anchor(file.page.toc, url.fragment)
+            if not anchor:
+                log.warning(
+                    f"Error reading metadata of post '{path}' in '{docs}':\n"
+                    f"Couldn't find anchor '{url.fragment}' in '{url.path}'"
+                )
+
+                # Restore link to original state
+                link.url = url.geturl()
+                continue
+
+            # Append anchor to URL and set subtitle
+            link.url += f"#{anchor.id}"
+            link.meta["subtitle"] = anchor.title
+
+    # -------------------------------------------------------------------------
+
+    # Attach a list of pages to each other and to the given parent item without
+    # explicitly adding them to the navigation, which can be done by the caller
+    def _attach(self, parent: StructureItem, pages: list[Page]):
+        for tail, page, head in zip(pages, pages[1:], pages[2:]):
+
+            # Link page to parent and siblings
+            page.parent        = parent
+            page.previous_page = tail
+            page.next_page     = head
+
+            # If the page is a view, we know that we generated it and need to
+            # link its siblings back to the view
+            if isinstance(page, View):
+                view = self._resolve_original(page)
+                if tail: tail.next_page     = view
+                if head: head.previous_page = view
+
+    # Attach a page to the given parent and link it to the previous and next
+    # page of the given host - this is exclusively used for paginated views
+    def _attach_at(self, parent: StructureItem, host: Page, page: Page):
+        self._attach(parent, [host.previous_page, page, host.next_page])
+
+    # Attach a section as a sibling to the given view, make sure its pages are
+    # part of the navigation, and ensure all pages are linked correctly
+    def _attach_to(self, view: View, section: Section, nav: Navigation):
+        section.parent = view.parent
+
+        # Resolve siblings, which are the children of the parent section, or
+        # the top-level list of navigation items if the view is at the root of
+        # the project, and append the given section to it. It's currently not
+        # possible to chose the position of a section.
+        items = self._resolve_siblings(view, nav)
+        items.append(section)
+
+        # Find last sibling that is a page, skipping sections, as we need to
+        # append the given section after all other pages
+        tail = next(item for item in reversed(items) if isinstance(item, Page))
+        head = tail.next_page
+
+        # Attach section to navigation and pages to each other
+        nav.pages.extend(section.children)
+        self._attach(section, [tail, *section.children, head])
+
+    # -------------------------------------------------------------------------
+
+    # Render excerpts and pagination for the given view
+    def _render(self, view: View):
+        posts, pagination = view.posts, None
+
+        # Create pagination, if enabled
+        if self._config_pagination(view):
+            at = view.pages.index(view)
+
+            # Compute pagination boundaries
+            step = self._config_pagination_per_page(view)
+            p, q = at * step, at * step + step
+
+            # Extract posts in pagination boundaries
+            posts = view.posts[p:q]
+            pagination = self._render_pagination(view, (p, q))
+
+        # Render excerpts for selected posts
+        posts = [
+            self._render_post(post.excerpt, view)
+                for post in posts if post.excerpt
+        ]
+
+        # Return posts and pagination
+        return posts, pagination
+
+    # Render excerpt in the context of the given view
+    def _render_post(self, excerpt: Excerpt, view: View):
+        excerpt.render(view, self.config.post_excerpt_separator)
+
+        # Attach top-level table of contents item to view if it should be added
+        # and both, the view and excerpt contain table of contents items
+        toc = self._config_toc(view)
+        if toc and excerpt.toc.items and view.toc.items:
+            view.toc.items[0].children.append(excerpt.toc.items[0])
+
+        # Return excerpt
+        return excerpt
+
+    # Create pagination for the given view and range
+    def _render_pagination(self, view: View, range: tuple[int, int]):
+        p, q = range
+
+        # Create URL from the given page to another page
+        def url_maker(n: int):
+            return get_relative_url(view.pages[n - 1].url, view.url)
+
+        # Return pagination
+        return Pagination(
+            view.posts, page = q // (q - p),
+            items_per_page = q - p,
+            url_maker = url_maker
+        )
+
+    # -------------------------------------------------------------------------
+
+    # Retrieve configuration value or return default
+    def _config(self, key: str, default: any):
+        return default if self.config[key] is None else self.config[key]
+
+    # Retrieve configuration value for table of contents
+    def _config_toc(self, view: View):
+        default = self.config.blog_toc
+        if isinstance(view, Archive):
+            return self._config("archive_toc", default)
+        if isinstance(view, Category):
+            return self._config("categories_toc", default)
+        if isinstance(view, Profile):
+            return self._config("authors_profiles_toc", default)
+        else:
+            return default
+
+    # Retrieve configuration value for pagination
+    def _config_pagination(self, view: View):
+        default = self.config.pagination
+        if isinstance(view, Archive):
+            return self._config("archive_pagination", default)
+        if isinstance(view, Category):
+            return self._config("categories_pagination", default)
+        if isinstance(view, Profile):
+            return self._config("authors_profiles_pagination", default)
+        else:
+            return default
+
+    # Retrieve configuration value for pagination per page
+    def _config_pagination_per_page(self, view: View):
+        default = self.config.pagination_per_page
+        if isinstance(view, Archive):
+            return self._config("archive_pagination_per_page", default)
+        if isinstance(view, Category):
+            return self._config("categories_pagination_per_page", default)
+        if isinstance(view, Profile):
+            return self._config("authors_profiles_pagination_per_page", default)
+        else:
+            return default
+
+    # -------------------------------------------------------------------------
+
+    # Format path for post
+    def _format_path_for_post(self, post: Post, config: MkDocsConfig):
+        categories = post.config.categories[:self.config.post_url_max_categories]
+        categories = [self._slugify_category(name) for name in categories]
+
+        # Replace placeholders in format string
+        date = post.config.date.created
+        path = self.config.post_url_format.format(
+            categories = "/".join(categories),
+            date = self._format_date_for_post_url(date, config),
+            file = post.file.name,
+            slug = post.config.slug or self._slugify_post(post)
+        )
+
+        # Normalize path and strip slashes at the beginning and end
+        path = posixpath.normpath(path.strip("/"))
+        return posixpath.join(self.config.blog_dir, f"{path}.md")
+
+    # Format path for archive
+    def _format_path_for_archive(self, post: Post, config: MkDocsConfig):
+        date = post.config.date.created
+        path = self.config.archive_url_format.format(
+            date = self._format_date_for_archive_url(date, config)
+        )
+
+        # Normalize path and strip slashes at the beginning and end
+        path = posixpath.normpath(path.strip("/"))
+        return posixpath.join(self.config.blog_dir, f"{path}.md")
+
+    # Format path for category
+    def _format_path_for_category(self, name: str):
+        path = self.config.categories_url_format.format(
+            slug = self._slugify_category(name)
+        )
+
+        # Normalize path and strip slashes at the beginning and end
+        path = posixpath.normpath(path.strip("/"))
+        return posixpath.join(self.config.blog_dir, f"{path}.md")
+
+    # Format path for profile
+    def _format_path_for_profile(self, id: str, author: Author):
+        path = self.config.authors_profiles_url_format.format(
+            slug = author.slug or id,
+            name = author.name
+        )
+
+        # Normalize path and strip slashes at the beginning and end
+        path = posixpath.normpath(path.strip("/"))
+        return posixpath.join(self.config.blog_dir, f"{path}.md")
+
+    # Format path for pagination
+    def _format_path_for_pagination(self, view: View, page: int):
+        path = self.config.pagination_url_format.format(
+            page = page
+        )
+
+        # Compute base path for pagination - if the given view is an index file,
+        # we need to pop the file name from the base so it's not part of the URL
+        # and we need to append `index` to the path, so the paginated view is
+        # also an index page - see https://t.ly/71MKF
+        base, _ = posixpath.splitext(view.file.src_uri)
+        if view.is_index:
+            base = posixpath.dirname(base)
+            path = posixpath.join(path, "index")
+
+        # Normalize path and strip slashes at the beginning and end
+        path = posixpath.normpath(path.strip("/"))
+        return posixpath.join(base, f"{path}.md")
+
+    # -------------------------------------------------------------------------
+
+    # Format date - if the given format string refers to a predefined format,
+    # we format the date without a time component in order to keep sane default
+    # behavior, since authors will not expect time to be relevant for most posts
+    # as by our assumptions - see https://t.ly/Yi7ZC
+    def _format_date(self, date: datetime, format: str, config: MkDocsConfig):
+        locale: str = config.theme["language"].replace("-", "_")
+        if format in ["full", "long", "medium", "short"]:
+            return format_date(date, format = format, locale = locale)
+        else:
+            return format_datetime(date, format = format, locale = locale)
+
+    # Format date for post
+    def _format_date_for_post(self, date: datetime, config: MkDocsConfig):
+        format = self.config.post_date_format
+        return self._format_date(date, format, config)
+
+    # Format date for post URL
+    def _format_date_for_post_url(self, date: datetime, config: MkDocsConfig):
+        format = self.config.post_url_date_format
+        return self._format_date(date, format, config)
+
+    # Format date for archive
+    def _format_date_for_archive(self, date: datetime, config: MkDocsConfig):
+        format = self.config.archive_date_format
+        return self._format_date(date, format, config)
+
+    # Format date for archive URL
+    def _format_date_for_archive_url(self, date: datetime, config: MkDocsConfig):
+        format = self.config.archive_url_date_format
+        return self._format_date(date, format, config)
+
+    # -------------------------------------------------------------------------
+
+    # Slugify post title
+    def _slugify_post(self, post: Post):
+        separator = self.config.post_slugify_separator
+        return self.config.post_slugify(post.title, separator)
+
+    # Slugify category
+    def _slugify_category(self, name: str):
+        separator = self.config.categories_slugify_separator
+        return self.config.categories_slugify(name, separator)
+
+    # -------------------------------------------------------------------------
+
+    # Create a file for the given path, which must point to a valid source file,
+    # either inside the temporary directory or the docs directory
+    def _path_to_file(self, path: str, config: MkDocsConfig, *, temp = True):
+        assert path.endswith(".md")
+        file = File(
+            path,
+            config.docs_dir if not temp else self.temp_dir,
+            config.site_dir,
+            config.use_directory_urls
+        )
+
+        # Hack: mark file as generated, so other plugins don't think it's part
+        # of the file system. This is more or less a new quasi-standard that
+        # still needs to be adopted by MkDocs, and was introduced by the
+        # git-revision-date-localized-plugin - see https://bit.ly/3ZUmdBx
+        if temp:
+            file.generated_by = "material/blog"
+
+        # Return file
+        return file
+
+    # Create a file with the given content on disk
+    def _save_to_file(self, path: str, content: str):
+        os.makedirs(os.path.dirname(path), exist_ok = True)
+        with open(path, "w", encoding = "utf-8") as f:
+            f.write(content)
+
+    # -------------------------------------------------------------------------
+
+    # Translate the placeholder referenced by the given key
+    def _translate(self, key: str, config: MkDocsConfig) -> str:
+        env = config.theme.get_env()
+        template = env.get_template(
+            "partials/language.html", globals = { "config": config }
+        )
+
+        # Translate placeholder
+        return template.module.t(key)
+
+# -----------------------------------------------------------------------------
+# Helper functions
+# -----------------------------------------------------------------------------
+
+# Find all links in the given list of items
+def _find_links(items: list[StructureItem]):
+    for item in items:
+
+        # Resolve link
+        if isinstance(item, Link):
+            yield item
+
+        # Resolve sections recursively
+        if isinstance(item, Section):
+            for item in _find_links(item.children):
+                assert isinstance(item, Link)
+                yield item
+
+# Find anchor in table of contents for the given id
+def _find_anchor(toc: TableOfContents, id: str):
+    for anchor in toc:
+        if anchor.id == id:
+            return anchor
+
+        # Resolve anchors recursively
+        anchor = _find_anchor(anchor.children, id)
+        if isinstance(anchor, AnchorLink):
+            return anchor
+
+# -----------------------------------------------------------------------------
+# Data
+# -----------------------------------------------------------------------------
+
+# Set up logging
+log = logging.getLogger("mkdocs.material.blog")

micromamba_root/Lib/site-packages/material/plugins/group/__init__.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.

micromamba_root/Lib/site-packages/material/plugins/group/config.py

@@ -0,0 +1,31 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from mkdocs.config.config_options import Type
+from mkdocs.config.base import Config
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Group plugin configuration
+class GroupConfig(Config):
+    enabled = Type(bool, default = False)
+    plugins = Type((list, dict))

micromamba_root/Lib/site-packages/material/plugins/group/plugin.py

@@ -0,0 +1,161 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from __future__ import annotations
+
+import logging
+
+from collections.abc import Callable
+from mkdocs.config.config_options import Plugins
+from mkdocs.config.defaults import MkDocsConfig
+from mkdocs.exceptions import PluginError
+from mkdocs.plugins import BasePlugin, event_priority
+
+from .config import GroupConfig
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Group plugin
+class GroupPlugin(BasePlugin[GroupConfig]):
+    supports_multiple_instances = True
+
+    # Initialize plugin
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # Initialize object attributes
+        self.is_serve = False
+        self.is_dirty = False
+
+    # Determine whether we're serving the site
+    def on_startup(self, *, command, dirty):
+        self.is_serve = command == "serve"
+        self.is_dirty = dirty
+
+    # If the group is enabled, conditionally load plugins - at first, this might
+    # sound easier than it actually is, as we need to jump through some hoops to
+    # ensure correct ordering among plugins. We're effectively initializing the
+    # plugins that are part of the group after all MkDocs finished initializing
+    # all other plugins, so we need to patch the order of the methods. Moreover,
+    # we must use MkDocs existing plugin collection, or we might have collisions
+    # with other plugins that are not part of the group. As so often, this is a
+    # little hacky, but has huge potential making plugin configuration easier.
+    # There's one little caveat: the `__init__` and `on_startup` methods of the
+    # plugins that are part of the group are called after all other plugins, so
+    # the `event_priority` decorator for `on_startup` methods is effectively
+    # useless. However, the `on_startup` method is only intended to set up the
+    # plugin and doesn't receive anything else than the invoked command and
+    # whether we're running a dirty build, so there should be no problems.
+    @event_priority(150)
+    def on_config(self, config):
+        if not self.config.enabled:
+            return
+
+        # Retrieve plugin collection from configuration
+        option: Plugins = dict(config._schema)["plugins"]
+        assert isinstance(option, Plugins)
+
+        # Load all plugins in group
+        self.plugins: dict[str, BasePlugin] = {}
+        try:
+            for name, plugin in self._load(option):
+                self.plugins[name] = plugin
+
+        # The plugin could not be loaded, likely because it's not installed or
+        # misconfigured, so we raise a plugin error for a nicer error message
+        except Exception as e:
+            raise PluginError(str(e))
+
+        # Patch order of plugin methods
+        for events in option.plugins.events.values():
+            self._patch(events, config)
+
+        # Invoke `on_startup` event for plugins in group
+        command = "serve" if self.is_serve else "build"
+        for method in option.plugins.events["startup"]:
+            plugin = self._get_plugin(method)
+
+            # Ensure that we have a method bound to a plugin (and not a hook)
+            if plugin and plugin in self.plugins.values():
+                method(command = command, dirty = self.is_dirty)
+
+    # -------------------------------------------------------------------------
+
+    # Retrieve plugin instance for bound method or nothing
+    def _get_plugin(self, method: Callable):
+        return getattr(method, "__self__", None)
+
+    # Retrieve priority of plugin method
+    def _get_priority(self, method: Callable):
+        return getattr(method, "mkdocs_priority", 0)
+
+    # Retrieve position of plugin
+    def _get_position(self, plugin: BasePlugin, config: MkDocsConfig) -> int:
+        for at, (_, candidate) in enumerate(config.plugins.items()):
+            if plugin == candidate:
+                return at
+
+    # -------------------------------------------------------------------------
+
+    # Load plugins that are part of the group
+    def _load(self, option: Plugins):
+        for name, data in option._parse_configs(self.config.plugins):
+            yield option.load_plugin_with_namespace(name, data)
+
+    # -------------------------------------------------------------------------
+
+    # Patch order of plugin methods - all other plugin methods are already in
+    # the right order, so we only need to check those that are part of the group
+    # and bubble them up into the right location. Some plugin methods may define
+    # priorities, so we need to make sure to order correctly within those.
+    def _patch(self, methods: list[Callable], config: MkDocsConfig):
+        position = self._get_position(self, config)
+        for at in reversed(range(1, len(methods))):
+            tail = methods[at - 1]
+            head = methods[at]
+
+            # Skip if the plugin is not part of the group
+            plugin = self._get_plugin(head)
+            if not plugin or plugin not in self.plugins.values():
+                continue
+
+            # Skip if the previous method has a higher priority than the current
+            # one, because we know we can't swap them anyway
+            if self._get_priority(tail) > self._get_priority(head):
+                continue
+
+            # Ensure that we have a method bound to a plugin (and not a hook)
+            plugin = self._get_plugin(tail)
+            if not plugin:
+                continue
+
+            # Both methods have the same priority, so we check if the ordering
+            # of both methods is violated, and if it is, swap them
+            if (position < self._get_position(plugin, config)):
+                methods[at], methods[at - 1] = tail, head
+
+# -----------------------------------------------------------------------------
+# Data
+# -----------------------------------------------------------------------------
+
+# Set up logging
+log = logging.getLogger("mkdocs.material.group")

micromamba_root/Lib/site-packages/material/plugins/info/__init__.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.

micromamba_root/Lib/site-packages/material/plugins/info/config.py

@@ -0,0 +1,35 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from mkdocs.config.config_options import Type
+from mkdocs.config.base import Config
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Info plugin configuration
+class InfoConfig(Config):
+    enabled = Type(bool, default = True)
+    enabled_on_serve = Type(bool, default = False)
+
+    # Settings for archive
+    archive = Type(bool, default = True)
+    archive_stop_on_violation = Type(bool, default = True)

micromamba_root/Lib/site-packages/material/plugins/info/patterns.py

@@ -0,0 +1,27 @@
+def get_exclusion_patterns():
+    """
+    Regex patterns, which will be compared against directory and file names
+    case-sensitively. https://docs.python.org/3/library/re.html#re.search is the
+    matching function and scans the whole string to find any pattern match. Used
+    with the https://pypi.org/project/regex/ module.
+
+    Additional remarks for pattern creation:
+    - The compared paths will be always in POSIX format.
+    - Each directory path will have a / at the end to allow to distinguish them
+      from files.
+    - Patterns for dynamic or custom paths like Virtual Environments (venv) or
+      build site directories are created during plugin runtime.
+    """
+    return [
+        r"/__pycache__/",               # Python cache directory
+
+        r"/\.DS_Store$",                # macOS
+
+        r"/[^/]+\.zip$",                # Generated files and folders
+
+        r"/[^/]*\.cache($|/)",          # .cache files and folders
+
+        r"/\.vscode/",                  # Common autogenerated IDE directories
+        r"/\.vs/",
+        r"/\.idea/",
+    ]

micromamba_root/Lib/site-packages/material/plugins/info/plugin.py

@@ -0,0 +1,563 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+import getpass
+import glob
+import json
+import logging
+import os
+import platform
+import re
+import requests
+import site
+import sys
+import yaml
+
+from colorama import Fore, Style
+from importlib.metadata import distributions, version
+from io import BytesIO
+from markdown.extensions.toc import slugify
+from mkdocs.config.defaults import MkDocsConfig
+from mkdocs.plugins import BasePlugin, event_priority
+from mkdocs.utils.yaml import get_yaml_loader
+from zipfile import ZipFile, ZIP_DEFLATED
+
+from .config import InfoConfig
+from .patterns import get_exclusion_patterns
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Info plugin
+class InfoPlugin(BasePlugin[InfoConfig]):
+
+    # Initialize plugin
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # Initialize incremental builds
+        self.is_serve = False
+
+        # Initialize empty members
+        self.exclusion_patterns = []
+        self.excluded_entries = []
+
+    # Determine whether we're serving the site
+    def on_startup(self, *, command, dirty):
+        self.is_serve = command == "serve"
+
+    # Create a self-contained example (run earliest) - determine all files that
+    # are visible to MkDocs and are used to build the site, create an archive
+    # that contains all of them, and print a summary of the archive contents.
+    # The author must attach this archive to the bug report.
+    @event_priority(100)
+    def on_config(self, config):
+        if not self.config.enabled:
+            return
+
+        # By default, the plugin is disabled when the documentation is served,
+        # but not when it is built. This should nicely align with the expected
+        # user experience when creating reproductions.
+        if not self.config.enabled_on_serve and self.is_serve:
+            return
+
+        # Resolve latest version
+        url = "https://github.com/squidfunk/mkdocs-material/releases/latest"
+        res = requests.get(url, allow_redirects = False)
+
+        # Check if we're running the latest version
+        _, current = res.headers.get("location").rsplit("/", 1)
+        present = version("mkdocs-material")
+        if not present.startswith(current):
+            log.error("Please upgrade to the latest version.")
+            self._help_on_versions_and_exit(present, current)
+
+        # Exit if archive creation is disabled
+        if not self.config.archive:
+            sys.exit(1)
+
+        # Print message that we're creating a bug report
+        log.info("Started archive creation for bug report")
+
+        # Check that there are no overrides in place - we need to use a little
+        # hack to detect whether the custom_dir setting was used without parsing
+        # mkdocs.yml again - we check at which position the directory provided
+        # by the theme resides, and if it's not the first one, abort.
+        if config.theme.custom_dir:
+            log.error("Please remove 'custom_dir' setting.")
+            self._help_on_customizations_and_exit()
+
+        # Check that there are no hooks in place - hooks can alter the behavior
+        # of MkDocs in unpredictable ways, which is why they must be considered
+        # being customizations. Thus, we can't offer support for debugging and
+        # must abort here.
+        if config.hooks:
+            log.error("Please remove 'hooks' setting.")
+            self._help_on_customizations_and_exit()
+
+        # Assure all paths that will be validated are absolute. Convert possible
+        # relative config_file_path to absolute. Its absolute directory path is
+        # being later used to resolve other paths.
+        config.config_file_path = _convert_to_abs(config.config_file_path)
+        config_file_parent = os.path.dirname(config.config_file_path)
+
+        # Convert relative custom_dir path to absolute. The Theme.custom_dir
+        # property cannot be set, therefore a helper variable is used.
+        if config.theme.custom_dir:
+            abs_custom_dir = _convert_to_abs(
+                config.theme.custom_dir,
+                abs_prefix = config_file_parent
+            )
+        else:
+            abs_custom_dir = ""
+
+        # Extract the absolute path to projects plugin's directory to explicitly
+        # support path validation and dynamic exclusion for the plugin
+        projects_plugin = config.plugins.get("material/projects")
+        if projects_plugin:
+            abs_projects_dir = _convert_to_abs(
+                projects_plugin.config.projects_dir,
+                abs_prefix = config_file_parent
+            )
+        else:
+            abs_projects_dir = ""
+
+        # MkDocs removes the INHERIT configuration key during load, and doesn't
+        # expose the information in any way, as the parent configuration is
+        # merged into one. To validate that the INHERIT config file will be
+        # included in the ZIP file the current config file must be loaded again
+        # without parsing. Each file can have their own INHERIT key, so a list
+        # of configurations is supported. The INHERIT path is converted during
+        # load to absolute.
+        loaded_configs = _load_yaml(config.config_file_path)
+        if not isinstance(loaded_configs, list):
+            loaded_configs = [loaded_configs]
+
+        # It can happen that the drive letter case is inconsistent on Windows.
+        # Therefore, assure first character to be uppercase for the following
+        # checks. See: https://t.ly/9t1SU
+        site_prefixes = list(map(capitalize, site.PREFIXES))
+        cwd = capitalize(os.getcwd())
+
+        # We need to make sure the user put every file in the current working
+        # directory. To assure the reproduction inside the ZIP file can be run,
+        # validate that the MkDocs paths are children of the current root.
+        paths_to_validate = list(map(capitalize, [
+            config.config_file_path,
+            config.docs_dir,
+            abs_custom_dir,
+            abs_projects_dir,
+            *[cfg.get("INHERIT", "") for cfg in loaded_configs]
+        ]))
+
+        # Convert relative hook paths to absolute path
+        for hook in config.hooks:
+            path = _convert_to_abs(hook, abs_prefix = config_file_parent)
+            paths_to_validate.append(path)
+
+        # Remove valid paths from the list
+        for path in list(paths_to_validate):
+            if not path or path.startswith(cwd):
+                paths_to_validate.remove(path)
+
+        # Report the invalid paths to the user
+        if paths_to_validate:
+            log.error("One or more paths aren't children of root")
+            self._help_on_not_in_cwd(paths_to_validate)
+
+        # Create in-memory archive and prompt author for a short descriptive
+        # name for the archive, which is also used as the directory name. Note
+        # that the name is slugified for better readability and stripped of any
+        # file extension that the author might have entered.
+        archive = BytesIO()
+        example = input("\nPlease name your bug report (2-4 words): ")
+        example, _ = os.path.splitext(example)
+        example = "-".join([present, slugify(example, "-")])
+
+        # Get local copy of the exclusion patterns
+        self.exclusion_patterns = get_exclusion_patterns()
+        self.excluded_entries = []
+
+        # Exclude the site_dir at project root
+        if capitalize(config.site_dir).startswith(cwd):
+            self.exclusion_patterns.append(_resolve_pattern(config.site_dir))
+
+        # Exclude the Virtual Environment directory. site.getsitepackages() has
+        # inconsistent results across operating systems, and relies on the
+        # PREFIXES that will contain the absolute path to the activated venv.
+        for path in site_prefixes:
+            if path.startswith(cwd):
+                self.exclusion_patterns.append(_resolve_pattern(path))
+
+        # Guess other Virtual Environment paths in case we forget to activate
+        # them or in case we have multiple. Making sure which venv is activated
+        # is not necessary, as it is an optional step in the guidelines.
+        for abs_root, dirnames, filenames in os.walk(os.getcwd()):
+            for filename in filenames:
+                if filename.lower() != "pyvenv.cfg":
+                    continue
+
+                path = capitalize(abs_root)
+
+                if path not in site_prefixes:
+                    print(f"Possible inactive venv: {path}")
+                    self.exclusion_patterns.append(_resolve_pattern(path))
+
+        # Exclude site_dir for projects
+        if projects_plugin:
+            for path in glob.iglob(
+                pathname = projects_plugin.config.projects_config_files,
+                root_dir = abs_projects_dir,
+                recursive = True
+            ):
+                current_config_file = os.path.join(abs_projects_dir, path)
+                project_config = _get_project_config(current_config_file)
+                pattern = _resolve_pattern(project_config.site_dir)
+                self.exclusion_patterns.append(pattern)
+
+        # Track dotpath inclusion to inform about it later
+        contains_dotpath: bool = False
+
+        # Create self-contained example from project
+        files: list[str] = []
+        with ZipFile(archive, "a", ZIP_DEFLATED, False) as f:
+            for abs_root, dirnames, filenames in os.walk(os.getcwd()):
+                # Set and print progress indicator
+                indicator = f"Processing: {abs_root}"
+                print(indicator, end="\r", flush=True)
+
+                # Prune the folders in-place to prevent their processing
+                for name in list(dirnames):
+                    # Resolve the absolute directory path
+                    path = os.path.join(abs_root, name)
+
+                    # Exclude the directory and all subdirectories
+                    if self._is_excluded(path):
+                        dirnames.remove(name)
+                        continue
+
+                    # Warn about .dotdirectories
+                    if _is_dotpath(path, log_warning = True):
+                        contains_dotpath = True
+
+                # Write files to the in-memory archive
+                for name in filenames:
+                    # Resolve the absolute file path
+                    path = os.path.join(abs_root, name)
+
+                    # Exclude the file
+                    if self._is_excluded(path):
+                        continue
+
+                    # Warn about .dotfiles
+                    if _is_dotpath(path, log_warning = True):
+                        contains_dotpath = True
+
+                    # Resolve the relative path to create a matching structure
+                    path = os.path.relpath(path, os.path.curdir)
+                    f.write(path, os.path.join(example, path))
+
+                # Clear the line for the next indicator
+                print(" " * len(indicator), end="\r", flush=True)
+
+            # Add information on installed packages
+            f.writestr(
+                os.path.join(example, "requirements.lock.txt"),
+                "\n".join(sorted([
+                    "==".join([package.name, package.version])
+                        for package in distributions()
+                ]))
+            )
+
+            # Try to get login to replace it with USERNAME placeholder
+            try:
+                username = getpass.getuser()
+            except Exception:
+                username = "USERNAME"
+
+            # Add information on platform
+            f.writestr(
+                os.path.join(example, "platform.json"),
+                json.dumps(
+                    {
+                        "system": platform.platform(),
+                        "architecture": platform.architecture(),
+                        "python": platform.python_version(),
+                        "cwd": os.getcwd(),
+                        "command": " ".join([
+                            sys.argv[0].rsplit(os.sep, 1)[-1],
+                            *sys.argv[1:]
+                        ]),
+                        "env:$PYTHONPATH": os.getenv("PYTHONPATH", ""),
+                        "env:$VIRTUAL_ENV": os.getenv("VIRTUAL_ENV", ""),
+                        "sys.path": sys.path,
+                        "excluded_entries": self.excluded_entries
+                    },
+                    default = str,
+                    indent = 2
+                ).replace(username, "USERNAME")
+            )
+
+            # Retrieve list of processed files
+            for a in f.filelist:
+                # Highlight .dotpaths in a more explicit manner
+                color = (Fore.LIGHTYELLOW_EX if "/." in a.filename
+                         else Fore.LIGHTBLACK_EX)
+                files.append("".join([
+                    color, a.filename, " ",
+                    _size(a.compress_size)
+                ]))
+
+        # Finally, write archive to disk
+        buffer = archive.getbuffer()
+        with open(f"{example}.zip", "wb") as f:
+            f.write(archive.getvalue())
+
+        # Print summary
+        log.info("Archive successfully created:")
+        print(Style.NORMAL)
+
+        # Print archive file names
+        files.sort()
+        for file in files:
+            print(f"  {file}")
+
+        # Print archive name
+        print(Style.RESET_ALL)
+        print("".join([
+            "  ", f.name, " ",
+            _size(buffer.nbytes, 10)
+        ]))
+
+        # Print warning when file size is excessively large
+        print(Style.RESET_ALL)
+        if buffer.nbytes > 1000000:
+            log.warning("Archive exceeds recommended maximum size of 1 MB")
+
+        # Print warning when file contains hidden .dotpaths
+        if contains_dotpath:
+            log.warning(
+                "Archive contains dotpaths, which could contain sensitive "
+                "information.\nPlease review them at the bottom of the list "
+                "and share only necessary data to reproduce the issue."
+            )
+
+        # Aaaaaand done
+        sys.exit(1)
+
+    # -------------------------------------------------------------------------
+
+    # Print help on versions and exit
+    def _help_on_versions_and_exit(self, have, need):
+        print(Fore.RED)
+        print("  When reporting issues, please first upgrade to the latest")
+        print("  version of Material for MkDocs, as the problem might already")
+        print("  be fixed in the latest version. This helps reduce duplicate")
+        print("  efforts and saves us maintainers time.")
+        print(Style.NORMAL)
+        print(f"  Please update from {have} to {need}.")
+        print(Style.RESET_ALL)
+        print(f"  pip install --upgrade --force-reinstall mkdocs-material")
+        print(Style.NORMAL)
+
+        # Exit, unless explicitly told not to
+        if self.config.archive_stop_on_violation:
+            sys.exit(1)
+
+    # Print help on customizations and exit
+    def _help_on_customizations_and_exit(self):
+        print(Fore.RED)
+        print("  When reporting issues, you must remove all customizations")
+        print("  and check if the problem persists. If not, the problem is")
+        print("  caused by your overrides. Please understand that we can't")
+        print("  help you debug your customizations. Please remove:")
+        print(Style.NORMAL)
+        print("  - theme.custom_dir")
+        print("  - hooks")
+        print(Fore.YELLOW)
+        print("  Additionally, please remove all third-party JavaScript or")
+        print("  CSS not explicitly mentioned in our documentation:")
+        print(Style.NORMAL)
+        print("  - extra_css")
+        print("  - extra_javascript")
+        print(Fore.YELLOW)
+        print("  If you're using customizations from the theme's documentation")
+        print("  and you want to report a bug specific to those customizations")
+        print("  then set the 'archive_stop_on_violation: false' option in the")
+        print("  info plugin config.")
+        print(Style.RESET_ALL)
+
+        # Exit, unless explicitly told not to
+        if self.config.archive_stop_on_violation:
+            sys.exit(1)
+
+    # Print help on not in current working directory and exit
+    def _help_on_not_in_cwd(self, outside_root):
+        print(Fore.RED)
+        print("  The current working (root) directory:\n")
+        print(f"    {os.getcwd()}\n")
+        print("  is not a parent of the following paths:")
+        print(Style.NORMAL)
+        for path in outside_root:
+            print(f"    {path}")
+        print("\n  To assure that all project files are found please adjust")
+        print("  your config or file structure and put everything within the")
+        print("  root directory of the project.")
+        print("\n  Please also make sure `mkdocs build` is run in the actual")
+        print("  root directory of the project.")
+        print(Style.RESET_ALL)
+
+        # Exit, unless explicitly told not to
+        if self.config.archive_stop_on_violation:
+            sys.exit(1)
+
+    # Check if path is excluded and should be omitted from the zip. Use pattern
+    # matching for files and folders, and lookahead specific files in folders to
+    # skip them. Side effect: Save excluded paths to save them in the zip file.
+    def _is_excluded(self, abspath: str) -> bool:
+
+        # Resolve the path into POSIX format to match the patterns
+        pattern_path = _resolve_pattern(abspath, return_path = True)
+        for pattern in self.exclusion_patterns:
+            if re.search(pattern, pattern_path):
+                log.debug(f"Excluded pattern '{pattern}': {abspath}")
+                self.excluded_entries.append(f"{pattern} - {pattern_path}")
+                return True
+
+        # File exclusion should be limited to pattern matching
+        if os.path.isfile(abspath):
+            return False
+
+        # Projects, which don't use the projects plugin for multi-language
+        # support could have separate build folders for each config file or
+        # language. Therefore, we exclude them with the assumption a site_dir
+        # contains the sitemap file. Example of such a setup: https://t.ly/DLQcy
+        sitemap_gz = os.path.join(abspath, "sitemap.xml.gz")
+        if os.path.exists(sitemap_gz):
+            log.debug(f"Excluded site_dir: {abspath}")
+            self.excluded_entries.append(f"sitemap.xml.gz - {pattern_path}")
+            return True
+
+        return False
+
+# -----------------------------------------------------------------------------
+# Helper functions
+# -----------------------------------------------------------------------------
+
+# Print human-readable size
+def _size(value, factor = 1):
+    color = Fore.GREEN
+    if   value > 100000 * factor: color = Fore.RED
+    elif value >  25000 * factor: color = Fore.YELLOW
+    for unit in ["B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB"]:
+        if abs(value) < 1000.0:
+            return f"{color}{value:3.1f} {unit}"
+        value /= 1000.0
+
+# Get the absolute path with set prefix. To validate if a file is inside the
+# current working directory it needs to be absolute, so that it is possible to
+# check the prefix.
+def _convert_to_abs(path: str, abs_prefix: str = None) -> str:
+    if os.path.isabs(path): return path
+    if abs_prefix is None: abs_prefix = os.getcwd()
+    return os.path.normpath(os.path.join(abs_prefix, path))
+
+# Get the loaded config, or a list with all loaded configs. MkDocs removes the
+# INHERIT configuration key during load, and doesn't expose the information in
+# any way, as the parent configuration is merged into one. The INHERIT path is
+# needed for validation. This custom YAML loader replicates MkDocs' loading
+# logic. Side effect: It converts the INHERIT path to absolute.
+def _load_yaml(abs_src_path: str):
+
+    with open(abs_src_path, encoding ="utf-8-sig") as file:
+        source = file.read()
+
+    try:
+        result = yaml.load(source, Loader = get_yaml_loader()) or {}
+    except yaml.YAMLError:
+        result = {}
+
+    if "INHERIT" in result:
+        relpath = result.get('INHERIT')
+        parent_path = os.path.dirname(abs_src_path)
+        abspath = _convert_to_abs(relpath, abs_prefix = parent_path)
+        if os.path.exists(abspath):
+            result["INHERIT"] = abspath
+            log.debug(f"Loading inherited configuration file: {abspath}")
+            parent = _load_yaml(abspath)
+            if isinstance(parent, list):
+                result = [result, *parent]
+            elif isinstance(parent, dict):
+                result = [result, parent]
+
+    return result
+
+# Get a normalized POSIX path for the pattern matching with removed current
+# working directory prefix. Directory paths end with a '/' to allow more control
+# in the pattern creation for files and directories. The patterns are matched
+# using the search function, so they are prefixed with ^ for specificity.
+def _resolve_pattern(abspath: str, return_path: bool = False):
+    path = capitalize(abspath).replace(capitalize(os.getcwd()), "", 1)
+    path = path.replace(os.sep, "/").rstrip("/")
+
+    if not path:
+        return "/"
+
+    # Check abspath, as the file needs to exist
+    if not os.path.isfile(abspath):
+        path = path + "/"
+
+    return path if return_path else f"^{path}"
+
+# Get project configuration with resolved absolute paths for validation
+def _get_project_config(project_config_file: str):
+    with open(project_config_file, encoding="utf-8-sig") as file:
+        config = MkDocsConfig(config_file_path = project_config_file)
+        config.load_file(file)
+
+        # MkDocs transforms site_dir to absolute path during validation
+        config.validate()
+
+        return config
+
+# Check if the path is a .dotpath. A warning can also be issued when the param
+# is set. The function also returns a boolean to track results outside it.
+def _is_dotpath(path: str, log_warning: bool = False) -> bool:
+    posix_path = _resolve_pattern(path, return_path = True)
+    name = posix_path.rstrip("/").rsplit("/", 1)[-1]
+    if name.startswith("."):
+        if log_warning:
+            log.warning(f"The following .dotpath will be included: {path}")
+        return True
+    return False
+
+# It can happen that the drive letter case is inconsistent on Windows.
+# Capitalize the first character keeping the rest the same for comparison.
+# See: https://t.ly/9t1SU
+def capitalize(path: str):
+    return path[0].upper() + path[1:] if path else path
+
+# -----------------------------------------------------------------------------
+# Data
+# -----------------------------------------------------------------------------
+
+# Set up logging
+log = logging.getLogger("mkdocs.material.info")

micromamba_root/Lib/site-packages/material/plugins/meta/__init__.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.

micromamba_root/Lib/site-packages/material/plugins/meta/config.py

@@ -0,0 +1,33 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from mkdocs.config.config_options import Type
+from mkdocs.config.base import Config
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Meta plugin configuration
+class MetaConfig(Config):
+    enabled = Type(bool, default = True)
+
+    # Settings for meta files
+    meta_file = Type(str, default = ".meta.yml")

micromamba_root/Lib/site-packages/material/plugins/meta/plugin.py

@@ -0,0 +1,122 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+import logging
+import os
+import posixpath
+
+from mergedeep import Strategy, merge
+from mkdocs.exceptions import PluginError
+from mkdocs.structure.files import InclusionLevel
+from mkdocs.plugins import BasePlugin, event_priority
+from yaml import SafeLoader, load
+
+from .config import MetaConfig
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Meta plugin
+class MetaPlugin(BasePlugin[MetaConfig]):
+
+    # Construct metadata mapping
+    def on_files(self, files, *, config):
+        if not self.config.enabled:
+            return
+
+        # Initialize mapping
+        self.meta = {}
+
+        # Resolve and load meta files in docs directory
+        docs = os.path.relpath(config.docs_dir)
+        for file in files:
+            name = posixpath.basename(file.src_uri)
+            if not name == self.config.meta_file:
+                continue
+
+            # Exclude meta file from site directory - explicitly excluding the
+            # meta file allows the author to use a file name without '.' prefix
+            file.inclusion = InclusionLevel.EXCLUDED
+
+            # Open file and parse as YAML
+            with open(file.abs_src_path, encoding = "utf-8-sig") as f:
+                path = file.src_path
+                try:
+                    self.meta[path] = load(f, SafeLoader)
+
+                # The meta file could not be loaded because of a syntax error,
+                # which we display to the author with a nice error message
+                except Exception as e:
+                    raise PluginError(
+                        f"Error reading meta file '{path}' in '{docs}':\n"
+                        f"{e}"
+                    )
+
+    # Set metadata for page, if applicable (run earlier)
+    @event_priority(50)
+    def on_page_markdown(self, markdown, *, page, config, files):
+        if not self.config.enabled:
+            return
+
+        # Start with a clean state, as we first need to apply all meta files
+        # that are relevant to the current page, and then merge the page meta
+        # on top of that to ensure that the page meta always takes precedence
+        # over meta files - see https://t.ly/kvCRn
+        meta = {}
+
+        # Merge matching meta files in level-order
+        strategy = Strategy.TYPESAFE_ADDITIVE
+        for path, defaults in self.meta.items():
+            if not page.file.src_path.startswith(os.path.dirname(path)):
+                continue
+
+            # Skip if meta file was already merged - this happens in case of
+            # blog posts, as they need to be merged when posts are constructed,
+            # which is why we need to keep track of which meta files are applied
+            # to what pages using the `__extends` key.
+            page.meta.setdefault("__extends", [])
+            if path in page.meta["__extends"]:
+                continue
+
+            # Try to merge metadata
+            try:
+                merge(meta, defaults, strategy = strategy)
+                page.meta["__extends"].append(path)
+
+            # Merging the metadata with the given strategy resulted in an error,
+            # which we display to the author with a nice error message
+            except Exception as e:
+                docs = os.path.relpath(config.docs_dir)
+                raise PluginError(
+                    f"Error merging meta file '{path}' in '{docs}':\n"
+                    f"{e}"
+                )
+
+        # Ensure page metadata is merged last, so the author can override any
+        # defaults from the meta files, or even remove them entirely
+        page.meta = merge(meta, page.meta, strategy = strategy)
+
+# -----------------------------------------------------------------------------
+# Data
+# -----------------------------------------------------------------------------
+
+# Set up logging
+log = logging.getLogger("mkdocs.material.meta")

micromamba_root/Lib/site-packages/material/plugins/offline/__init__.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.

micromamba_root/Lib/site-packages/material/plugins/offline/config.py

@@ -0,0 +1,30 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+from mkdocs.config.config_options import Type
+from mkdocs.config.base import Config
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Offline plugin configuration
+class OfflineConfig(Config):
+    enabled = Type(bool, default = True)

micromamba_root/Lib/site-packages/material/plugins/offline/plugin.py

@@ -0,0 +1,69 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+import os
+
+from mkdocs.plugins import BasePlugin, event_priority
+
+from .config import OfflineConfig
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Offline plugin
+class OfflinePlugin(BasePlugin[OfflineConfig]):
+
+    # Set configuration for offline build
+    def on_config(self, config):
+        if not self.config.enabled:
+            return
+
+        # Ensure correct resolution of links when viewing the site from the
+        # file system by disabling directory URLs
+        config.use_directory_urls = False
+
+        # Append iframe-worker to polyfills/shims
+        config.extra["polyfills"] = config.extra.get("polyfills", [])
+        if not any("iframe-worker" in url for url in config.extra["polyfills"]):
+            script = "https://unpkg.com/iframe-worker/shim"
+            config.extra["polyfills"].append(script)
+
+    # Add support for offline search (run latest) - the search index is copied
+    # and inlined into a script, so that it can be used without a server
+    @event_priority(-100)
+    def on_post_build(self, *, config):
+        if not self.config.enabled:
+            return
+
+        # Ensure presence of search index
+        path = os.path.join(config.site_dir, "search")
+        file = os.path.join(path, "search_index.json")
+        if not os.path.isfile(file):
+            return
+
+        # Obtain search index contents
+        with open(file, encoding = "utf-8") as f:
+            data = f.read()
+
+        # Inline search index contents into script
+        file = os.path.join(path, "search_index.js")
+        with open(file, "w", encoding = "utf-8") as f:
+            f.write(f"var __index = {data}")

micromamba_root/Lib/site-packages/material/plugins/optimize/config.py

@@ -0,0 +1,52 @@
+# Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+import os
+
+from mkdocs.config.base import Config
+from mkdocs.config.config_options import ListOfItems, Type
+
+# -----------------------------------------------------------------------------
+# Classes
+# -----------------------------------------------------------------------------
+
+# Optimize plugin configuration
+class OptimizeConfig(Config):
+    enabled = Type(bool, default = True)
+    concurrency = Type(int, default = max(1, os.cpu_count() - 1))
+
+    # Settings for caching
+    cache = Type(bool, default = True)
+    cache_dir = Type(str, default = ".cache/plugin/optimize")
+
+    # Settings for optimization
+    optimize = Type(bool, default = True)
+    optimize_png = Type(bool, default = True)
+    optimize_png_speed = Type(int, default = 3)
+    optimize_png_strip = Type(bool, default = True)
+    optimize_jpg = Type(bool, default = True)
+    optimize_jpg_quality = Type(int, default = 60)
+    optimize_jpg_progressive = Type(bool, default = True)
+    optimize_include = ListOfItems(Type(str), default = [])
+    optimize_exclude = ListOfItems(Type(str), default = [])
+
+    # Settings for reporting
+    print_gain = Type(bool, default = True)
+    print_gain_summary = Type(bool, default = True)