mkdocs-ultralytics-plugin 0.2.5__tar.gz → 0.2.6__tar.gz

{mkdocs_ultralytics_plugin-0.2.5 → mkdocs_ultralytics_plugin-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-ultralytics-plugin
-Version: 0.2.5
+Version: 0.2.6
 Summary: An MkDocs plugin that provides Ultralytics Docs customizations at https://docs.ultralytics.com.
 Author-email: Glenn Jocher <hello@ultralytics.com>
 Maintainer-email: Ultralytics <hello@ultralytics.com>
@@ -24,6 +24,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Software Development
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
@@ -41,7 +42,7 @@ Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Dynamic: license-file
 
-<a href="https://www.ultralytics.com/"><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320" alt="Ultralytics logo"></a>
+<a href="https://www.ultralytics.com"><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320" alt="Ultralytics logo"></a>
 
 # 🚀 MkDocs Ultralytics Plugin
 
@@ -55,8 +56,8 @@ Welcome to the MkDocs Ultralytics Plugin! 📄 This powerful tool enhances your
 [![Ultralytics Actions](https://github.com/ultralytics/mkdocs/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/mkdocs/actions/workflows/format.yml)
 
 [![Ultralytics Discord](https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue)](https://discord.com/invite/ultralytics)
-[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com/)
-[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://reddit.com/r/ultralytics)
+[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com)
+[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://www.reddit.com/r/ultralytics/)
 
 ## ✨ Features
 
@@ -162,7 +163,7 @@ jekyll build && python postprocess.py
 
 ## ⚙️ Configuration Options
 
-Both modes support the same configuration options:
+Both modes support the feature options below. Differences: `enabled` applies to plugin mode only, while postprocess mode reads `site_dir`, `docs_dir`, and `site_url` as arguments (plugin mode gets these from `mkdocs.yml`) and additionally accepts `use_processes` (default `True`) and `workers` (default: CPU count) to control parallelism.
 
 | Option              | Type | Default | Description                      |
 | ------------------- | ---- | ------- | -------------------------------- |
@@ -238,7 +239,7 @@ Both plugin mode and postprocess mode use the same `process_html()` function in
 
 Collaboration fuels innovation! 🤗 The success of Ultralytics' open-source projects thrives on community contributions. We welcome your involvement, whether it's fixing bugs, proposing new features, improving documentation, engaging in discussions, or sharing how you use Ultralytics tools.
 
-Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for details. Filling out our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) also provides valuable feedback. We sincerely appreciate 🙇‍♂️ every contribution!
+Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing) for details. Filling out our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) also provides valuable feedback. We sincerely appreciate 🙇‍♂️ every contribution!
 
 [![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)](https://github.com/ultralytics/ultralytics/graphs/contributors)
 

{mkdocs_ultralytics_plugin-0.2.5 → mkdocs_ultralytics_plugin-0.2.6}/README.md

@@ -1,4 +1,4 @@
-<a href="https://www.ultralytics.com/"><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320" alt="Ultralytics logo"></a>
+<a href="https://www.ultralytics.com"><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320" alt="Ultralytics logo"></a>
 
 # 🚀 MkDocs Ultralytics Plugin
 
@@ -12,8 +12,8 @@ Welcome to the MkDocs Ultralytics Plugin! 📄 This powerful tool enhances your
 [![Ultralytics Actions](https://github.com/ultralytics/mkdocs/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/mkdocs/actions/workflows/format.yml)
 
 [![Ultralytics Discord](https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue)](https://discord.com/invite/ultralytics)
-[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com/)
-[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://reddit.com/r/ultralytics)
+[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com)
+[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://www.reddit.com/r/ultralytics/)
 
 ## ✨ Features
 
@@ -119,7 +119,7 @@ jekyll build && python postprocess.py
 
 ## ⚙️ Configuration Options
 
-Both modes support the same configuration options:
+Both modes support the feature options below. Differences: `enabled` applies to plugin mode only, while postprocess mode reads `site_dir`, `docs_dir`, and `site_url` as arguments (plugin mode gets these from `mkdocs.yml`) and additionally accepts `use_processes` (default `True`) and `workers` (default: CPU count) to control parallelism.
 
 | Option              | Type | Default | Description                      |
 | ------------------- | ---- | ------- | -------------------------------- |
@@ -195,7 +195,7 @@ Both plugin mode and postprocess mode use the same `process_html()` function in
 
 Collaboration fuels innovation! 🤗 The success of Ultralytics' open-source projects thrives on community contributions. We welcome your involvement, whether it's fixing bugs, proposing new features, improving documentation, engaging in discussions, or sharing how you use Ultralytics tools.
 
-Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for details. Filling out our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) also provides valuable feedback. We sincerely appreciate 🙇‍♂️ every contribution!
+Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing) for details. Filling out our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) also provides valuable feedback. We sincerely appreciate 🙇‍♂️ every contribution!
 
 [![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)](https://github.com/ultralytics/ultralytics/graphs/contributors)
 

{mkdocs_ultralytics_plugin-0.2.5 → mkdocs_ultralytics_plugin-0.2.6}/mkdocs_ultralytics_plugin.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-ultralytics-plugin
-Version: 0.2.5
+Version: 0.2.6
 Summary: An MkDocs plugin that provides Ultralytics Docs customizations at https://docs.ultralytics.com.
 Author-email: Glenn Jocher <hello@ultralytics.com>
 Maintainer-email: Ultralytics <hello@ultralytics.com>
@@ -24,6 +24,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Software Development
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
@@ -41,7 +42,7 @@ Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Dynamic: license-file
 
-<a href="https://www.ultralytics.com/"><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320" alt="Ultralytics logo"></a>
+<a href="https://www.ultralytics.com"><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320" alt="Ultralytics logo"></a>
 
 # 🚀 MkDocs Ultralytics Plugin
 
@@ -55,8 +56,8 @@ Welcome to the MkDocs Ultralytics Plugin! 📄 This powerful tool enhances your
 [![Ultralytics Actions](https://github.com/ultralytics/mkdocs/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/mkdocs/actions/workflows/format.yml)
 
 [![Ultralytics Discord](https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue)](https://discord.com/invite/ultralytics)
-[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com/)
-[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://reddit.com/r/ultralytics)
+[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com)
+[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://www.reddit.com/r/ultralytics/)
 
 ## ✨ Features
 
@@ -162,7 +163,7 @@ jekyll build && python postprocess.py
 
 ## ⚙️ Configuration Options
 
-Both modes support the same configuration options:
+Both modes support the feature options below. Differences: `enabled` applies to plugin mode only, while postprocess mode reads `site_dir`, `docs_dir`, and `site_url` as arguments (plugin mode gets these from `mkdocs.yml`) and additionally accepts `use_processes` (default `True`) and `workers` (default: CPU count) to control parallelism.
 
 | Option              | Type | Default | Description                      |
 | ------------------- | ---- | ------- | -------------------------------- |
@@ -238,7 +239,7 @@ Both plugin mode and postprocess mode use the same `process_html()` function in
 
 Collaboration fuels innovation! 🤗 The success of Ultralytics' open-source projects thrives on community contributions. We welcome your involvement, whether it's fixing bugs, proposing new features, improving documentation, engaging in discussions, or sharing how you use Ultralytics tools.
 
-Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for details. Filling out our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) also provides valuable feedback. We sincerely appreciate 🙇‍♂️ every contribution!
+Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing) for details. Filling out our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) also provides valuable feedback. We sincerely appreciate 🙇‍♂️ every contribution!
 
 [![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)](https://github.com/ultralytics/ultralytics/graphs/contributors)
 

{mkdocs_ultralytics_plugin-0.2.5 → mkdocs_ultralytics_plugin-0.2.6}/plugin/__init__.py

@@ -1,6 +1,6 @@
 # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
 
-__version__ = "0.2.5"
+__version__ = "0.2.6"
 
 from .main import MetaPlugin
 from .postprocess import postprocess_site

{mkdocs_ultralytics_plugin-0.2.5 → mkdocs_ultralytics_plugin-0.2.6}/plugin/main.py

@@ -8,7 +8,7 @@ from pathlib import Path
 from mkdocs.config import config_options
 from mkdocs.plugins import BasePlugin
 
-import plugin.processor as processor
+from plugin import processor
 from plugin.processor import process_html
 from plugin.utils import resolve_all_authors
 
@@ -67,7 +67,8 @@ class MetaPlugin(BasePlugin):
             )
 
         try:
-            page_url = (config["site_url"] or "") + page.url.rstrip("/")
+            # MkDocs normalizes site_url to end in "/" and gives the home page url "./"
+            page_url = f"{(config['site_url'] or '').rstrip('/')}/{page.url}".rstrip("/.") or "/"
             title = page.title
             keywords = page.meta.get("keywords", None) if hasattr(page, "meta") else None
 

{mkdocs_ultralytics_plugin-0.2.5 → mkdocs_ultralytics_plugin-0.2.6}/plugin/postprocess.py

@@ -14,7 +14,7 @@ try:
 except ImportError:
     TQDM = None
 
-import plugin.processor as processor
+from plugin import processor
 from plugin.processor import process_html
 from plugin.utils import resolve_all_authors
 
@@ -88,7 +88,7 @@ def process_html_file(
 
     # Get page URL - calculate relative path from site_dir
     rel_path = html_path.relative_to(site_dir).as_posix()
-    page_url = f"{site_url.rstrip('/')}/{rel_path}".replace("/index.html", "/")
+    page_url = f"{site_url.rstrip('/')}/{rel_path}".replace("/index.html", "") or "/"
 
     # Get title
     title = soup.find("h1").text if soup.find("h1") else soup.title.string if soup.title else ""
@@ -181,8 +181,9 @@ def generate_llms_txt(
 
     def md_to_url(md_path: str) -> str:
         """Convert markdown path to HTML URL."""
-        url = md_path.replace(".md", "/").replace("/index/", "/")
-        return f"{site_url}/{url}" if url != "index/" else f"{site_url}/"
+        url = md_path[:-3] if md_path.endswith(".md") else md_path
+        url = url[:-6] if url.endswith("/index") else url
+        return (site_url or "/") if url == "index" else f"{site_url}/{url}"
 
     if nav:
 
@@ -304,23 +305,23 @@ def postprocess_site(
     # Enable logging only for the synchronous path; pools run without per-task log_fn to remain pickle-safe.
     log_fn = (progress.write if verbose and progress else print if verbose else None) if worker_count == 1 else None
 
-    task_kwargs = dict(
-        site_dir=site_dir,
-        md_index=md_index,
-        git_data=git_data,
-        repo_url=repo_url,
-        site_url=site_url,
-        default_image=default_image,
-        add_desc=add_desc,
-        add_image=add_image,
-        add_keywords=add_keywords,
-        add_share_buttons=add_share_buttons,
-        add_authors=add_authors,
-        add_json_ld=add_json_ld,
-        add_css=add_css,
-        add_copy_llm=add_copy_llm,
-        verbose=verbose,
-    )
+    task_kwargs = {
+        "site_dir": site_dir,
+        "md_index": md_index,
+        "git_data": git_data,
+        "repo_url": repo_url,
+        "site_url": site_url,
+        "default_image": default_image,
+        "add_desc": add_desc,
+        "add_image": add_image,
+        "add_keywords": add_keywords,
+        "add_share_buttons": add_share_buttons,
+        "add_authors": add_authors,
+        "add_json_ld": add_json_ld,
+        "add_css": add_css,
+        "add_copy_llm": add_copy_llm,
+        "verbose": verbose,
+    }
 
     if worker_count == 1:
         for html_file in html_files:

{mkdocs_ultralytics_plugin-0.2.5 → mkdocs_ultralytics_plugin-0.2.6}/plugin/processor.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 import json
 import re
 import subprocess
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from pathlib import Path
 from typing import Any
 from urllib.parse import quote
@@ -15,7 +15,7 @@ from bs4 import BeautifulSoup
 
 from plugin.utils import calculate_time_difference, get_youtube_video_ids
 
-today = datetime.now()
+today = datetime.now(timezone.utc)
 DEFAULT_CREATION_DATE = (today - timedelta(days=365)).strftime("%Y-%m-%d %H:%M:%S +0000")
 DEFAULT_MODIFIED_DATE = (today - timedelta(days=40)).strftime("%Y-%m-%d %H:%M:%S +0000")
 
@@ -529,7 +529,7 @@ def process_html(
                 {
                     "@type": "Organization",
                     "name": "Ultralytics",
-                    "url": "https://ultralytics.com/",
+                    "url": "https://ultralytics.com",
                 }
             ],
             "abstract": meta.get("description", ""),

{mkdocs_ultralytics_plugin-0.2.5 → mkdocs_ultralytics_plugin-0.2.6}/plugin/utils.py

@@ -147,20 +147,17 @@ def resolve_github_user(
 
     # Query the commit API when git history provides a commit for this email. This resolves authors whose commit email
     # is linked to a GitHub account but hidden from user search.
-    if repo_path := _github_repo_path(repo_url):
-        if commit_sha:
-            try:
-                response = requests.get(
-                    f"https://api.github.com/repos/{repo_path}/commits/{commit_sha}", timeout=TIMEOUT
-                )
-                if response.status_code == 200:
-                    data = response.json()
-                    author = data.get("author") or {}
-                    if author.get("login") and author.get("avatar_url"):
-                        cache[email] = {"username": author["login"], "avatar": author["avatar_url"]}
-                        return cache[email]
-            except Exception:
-                pass
+    if (repo_path := _github_repo_path(repo_url)) and commit_sha:
+        try:
+            response = requests.get(f"https://api.github.com/repos/{repo_path}/commits/{commit_sha}", timeout=TIMEOUT)
+            if response.status_code == 200:
+                data = response.json()
+                author = data.get("author") or {}
+                if author.get("login") and author.get("avatar_url"):
+                    cache[email] = {"username": author["login"], "avatar": author["avatar_url"]}
+                    return cache[email]
+        except Exception:
+            pass
 
     # Query GitHub REST API
     if verbose:
@@ -238,7 +235,7 @@ def resolve_all_authors(
     # Build authors list for each file entry
     github_repo_url = repo_url or "https://github.com/ultralytics/ultralytics"
 
-    for file_path, entry in git_data.items():
+    for entry in git_data.values():
         emails = entry.get("emails", {})
         if not emails and default_author:
             emails = {default_author: 1}

{mkdocs_ultralytics_plugin-0.2.5 → mkdocs_ultralytics_plugin-0.2.6}/pyproject.toml

@@ -50,6 +50,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
     "Topic :: Software Development",
     "Topic :: Scientific/Engineering",
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
@@ -77,8 +78,5 @@ ultralytics = "plugin:MetaPlugin"  # executes the function `MetaPlugin` from thi
 [project.optional-dependencies]  # Optional
 dev = ["pytest"]
 
-[tool.setuptools]  # This is configuration specific to the `setuptools` build backend.
-package-data = { "sample" = ["*.yaml"] }
-
 [tool.setuptools.dynamic]
 version = {attr = "plugin.__version__"}