fr-docs 3.4.1__tar.gz → 3.5.0__tar.gz

{fr_docs-3.4.1 → fr_docs-3.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fr-docs
-Version: 3.4.1
+Version: 3.5.0
 Summary: Fast static documentation generator with search, versioning, and zero-config setup
 Author-email: Omena0 <omena0mc@gmail.com>
 License: # PolyForm Noncommercial License 1.0.0

{fr_docs-3.4.1 → fr_docs-3.5.0}/fr_docs/build.py

@@ -148,7 +148,7 @@ def _resolve_script_version(repo_root, script_rel_path, local_path):
     remote content is used instead.
     """
     local_version, local_hash = _script_version_hash(local_path)
-    remote_version, remote_hash = _script_version_hash(
+    remote_version, _remote_hash = _script_version_hash(
         Path(repo_root, script_rel_path)
     )
 

{fr_docs-3.4.1 → fr_docs-3.5.0}/fr_docs/git.py

@@ -57,13 +57,12 @@ def _build_pages_by_commit(out, slugs):
         elif current_commit:
             # Recover the slug from the file path: strip dir prefix and .md
             slug = line
-            if slug.endswith(".md"):
-                slug = slug[:-3]
+            slug = slug.removesuffix(".md")
             # Try to match against known slugs (handles prefix variations)
             matched = None
             for s in slugs:
-                src_path = s + ".md"
-                if line.endswith(src_path) or line.endswith(f"/{src_path}") or line == src_path:
+                src_path = f"{s}.md"
+                if line.endswith((src_path, f"/{src_path}")) or line == src_path:
                     matched = s
                     break
             if matched is None:

{fr_docs-3.4.1 → fr_docs-3.5.0}/fr_docs/html_pipeline.py

@@ -43,7 +43,7 @@ from .syntax import (
     process_blockquotes,
 )
 from .template import TEMPLATE, build_toc_sidebar
-from .utils import normalized_site_prefix, output_href, output_asset_href
+from .utils import normalized_site_prefix, output_asset_href, output_href
 
 
 def _determine_tagged_sections(config):

{fr_docs-3.4.1 → fr_docs-3.5.0}/fr_docs/markdown.py

@@ -13,7 +13,6 @@ from markdown.extensions.tables import TableExtension
 from .slug import (
     normalize_slug,
     relative_slug_path,
-    slug_output_name,
 )
 from .syntax import URL_ATTR_RE
 
@@ -38,20 +37,17 @@ def _parse_code_location(location):
     location = str(location or "").strip()
     if not location:
         return {}
+
     if re.fullmatch(r"\d+", location):
         return {"line": int(location)}
-    range_match = re.fullmatch(r"(\d+)-(\d+)(?::\d+)?", location)
-    if range_match:
-        return {
-            "line": int(range_match.group(1)),
-            "end_line": int(range_match.group(2)),
-        }
+
+    if range_match := re.fullmatch(r"(\d+)-(\d+)(?::\d+)?", location):
+        return {"line": int(range_match[1]), "end_line": int(range_match[2])}
+
     column_match = re.fullmatch(r"(\d+):(\d+)", location)
     if column_match:
-        return {
-            "line": int(column_match.group(1)),
-            "column": int(column_match.group(2)),
-        }
+        return {"line": int(column_match[1]), "column": int(column_match[2])}
+
     return {"function": location}
 
 

{fr_docs-3.4.1 → fr_docs-3.5.0}/fr_docs/search.py

@@ -5,7 +5,7 @@ from pathlib import Path
 
 from .config_accessors import feature_enabled
 from .frontmatter import parse_frontmatter
-from .slug import normalize_slug, relative_slug_path, slug_output_name
+from .slug import normalize_slug, slug_output_name
 from .utils import output_href
 
 # Symbol extraction patterns for various languages
@@ -229,18 +229,18 @@ def extract_symbols_from_content(content, language):
             if symbol_type in ("function", "method", "decorator_function") and language == "python":
                 # Find function end by indentation
                 indent_match = re.match(r"^[^\S\n]*", lines[line_num - 1])
-                indent = len(indent_match.group(0)) if indent_match else 0
+                indent = len(indent_match[0]) if indent_match else 0
                 end_line = line_num
+
                 for i in range(line_num, len(lines)):
                     if lines[i].strip():
                         indent_match = re.match(r"^[^\S\n]*", lines[i])
-                        line_indent = len(indent_match.group(0)) if indent_match else 0
+                        line_indent = len(indent_match[0]) if indent_match else 0
                         if line_indent <= indent:
                             end_line = i
                             break
-                        end_line = i + 1
-                    else:
-                        end_line = i + 1
+
+                    end_line = i + 1
 
             symbols.append(
                 {

fr_docs-3.5.0/fr_docs/update.py

@@ -0,0 +1,93 @@
+"""Update fr-docs resources (script.js, style.css, fonts) from upstream."""
+
+import tempfile
+from pathlib import Path
+
+from .build import (
+    _script_version_hash,
+    _write_script_js,
+)
+from .config import load_config
+from .config_accessors import project_name
+from .init import (
+    DEFAULT_CSS_URL,
+    FAVICON_SVG_URL,
+    SCRIPT_JS_URL,
+    STYLE_CSS_URL,
+    download_file,
+    run_fetch_fonts,
+)
+
+
+def update_resources(config):
+    """Update script.js, style.css, favicon.svg, and fonts from the fr-docs upstream repo.
+
+    Downloads the latest resources from raw.githubusercontent.com and writes them
+    to the local docs/ directory. For script.js, preserves version numbering
+    by reading the version from the downloaded content.
+    """
+    docs_path = Path(config["_docs_dir"]).resolve()
+    updated = []
+
+    # Update script.js
+    with tempfile.NamedTemporaryFile(mode="w+", suffix=".js", delete=False) as tmp:
+        tmp_path = Path(tmp.name)
+    try:
+        if download_file(SCRIPT_JS_URL, tmp_path):
+            version, _ = _script_version_hash(tmp_path)
+            content = tmp_path.read_text(encoding="utf-8")
+            local_path = docs_path / "script.js"
+            _write_script_js(local_path, version, content)
+            updated.append(f"script.js (v{version})")
+    finally:
+        tmp_path.unlink(missing_ok=True)
+
+    # Update style.css
+    local_style = docs_path / "style.css"
+    if download_file(STYLE_CSS_URL, local_style):
+        updated.append("style.css")
+
+    # Update favicon.svg
+    local_favicon = docs_path / "favicon.svg"
+    if download_file(FAVICON_SVG_URL, local_favicon):
+        updated.append("favicon.svg")
+
+    # Update fonts (download from Google Fonts, generate fonts.css)
+    fonts_dir = docs_path / "fonts"
+    if fonts_dir.is_dir():
+        old_count = len(list(fonts_dir.iterdir()))
+        result = run_fetch_fonts(docs_path, DEFAULT_CSS_URL)
+        if result == 0:
+            new_count = len(list(fonts_dir.iterdir()))
+            if new_count > old_count:
+                updated.append(f"fonts ({new_count - old_count} new)")
+            else:
+                updated.append("fonts (refreshed)")
+
+    if updated:
+        print(f"   Updated: {', '.join(updated)}")
+    else:
+        print("   No resources updated.")
+
+
+def main(argv=None) -> None:
+    import argparse
+
+    parser = argparse.ArgumentParser(
+        prog="fr-docs update",
+        description="Update fr-docs resources (script.js, style.css, fonts) from upstream.",
+    )
+    parser.add_argument(
+        "--config",
+        help="Path to the configuration JSON file.",
+    )
+    args = parser.parse_args(argv)
+
+    config = load_config(args.config)
+    print(f"🔄 Updating {project_name(config)} resources...")
+    update_resources(config)
+    print("✅ Update complete.")
+
+
+if __name__ == "__main__":
+    main()

{fr_docs-3.4.1 → fr_docs-3.5.0}/fr_docs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fr-docs
-Version: 3.4.1
+Version: 3.5.0
 Summary: Fast static documentation generator with search, versioning, and zero-config setup
 Author-email: Omena0 <omena0mc@gmail.com>
 License: # PolyForm Noncommercial License 1.0.0

{fr_docs-3.4.1 → fr_docs-3.5.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fr-docs"
-version = "3.4.1"
+version = "3.5.0"
 description = "Fast static documentation generator with search, versioning, and zero-config setup"
 readme = "README.md"
 requires-python = ">=3.14"

fr_docs-3.4.1/fr_docs/update.py

@@ -1,135 +0,0 @@
-"""Update fr-docs resources (script.js, style.css, fonts) from the repo."""
-
-import json
-import shutil
-import subprocess
-import sys
-from pathlib import Path
-
-from .config import load_config
-from .config_accessors import out_dir, project_name, src_dir as config_src_dir
-from .build import (
-    _resolve_script_version,
-    _write_script_js,
-    _minify_static_asset,
-    _script_version_hash,
-)
-
-
-def _fetch_remote(repo_root, rel_path):
-    """Fetch a file from the fr-docs repo via git show HEAD:path."""
-    try:
-        return subprocess.check_output(
-            ["git", "show", f"HEAD:{rel_path}"],
-            cwd=repo_root,
-            stderr=subprocess.DEVNULL,
-        ).decode("utf-8", errors="replace")
-    except (subprocess.CalledProcessError, OSError):
-        return None
-
-
-def _git_current_commit(repo_root):
-    try:
-        return subprocess.check_output(
-            ["git", "rev-parse", "HEAD"],
-            cwd=repo_root,
-            stderr=subprocess.DEVNULL,
-        ).decode("utf-8", errors="replace").strip()
-    except (subprocess.CalledProcessError, OSError):
-        return None
-
-
-def _git_remote_url(repo_root):
-    try:
-        return subprocess.check_output(
-            ["git", "remote", "get-url", "origin"],
-            cwd=repo_root,
-            stderr=subprocess.DEVNULL,
-        ).decode("utf-8", errors="replace").strip()
-    except (subprocess.CalledProcessError, OSError):
-        return None
-
-
-def _is_fr_docs_repo(repo_root):
-    """Return True if the repo is the fr-docs repo itself."""
-    url = _git_remote_url(repo_root) or ""
-    return "Omena0/fr-docs" in url or "omena0/fr-docs" in url.lower()
-
-
-def update_resources(config):
-    """Update script.js, style.css, favicon.svg, and fonts from the fr-docs repo.
-
-    Only runs when the current repo IS the fr-docs repo (so we can read
-    the source files from git). For downstream repos, the resources are
-    pulled from PyPI via the `fr-docs` package or copied from the docs/
-    directory.
-    """
-    docs_path = Path(config["_docs_dir"]).resolve()
-    repo_root = docs_path.parent
-    if not _is_fr_docs_repo(repo_root):
-        print("   Not the fr-docs repo; skipping remote resource update.")
-        return
-
-    resources = ["script.js", "style.css", "favicon.svg"]
-    updated = []
-    for name in resources:
-        rel = f"docs/{name}"
-        remote = _fetch_remote(repo_root, rel)
-        if remote is None:
-            continue
-        local_path = docs_path / name
-        if name == "script.js":
-            version, content = _resolve_script_version(repo_root, rel, local_path)
-            _write_script_js(local_path, version, content)
-            updated.append(f"{name} (v{version})")
-        else:
-            local_path.write_text(remote, encoding="utf-8")
-            updated.append(name)
-
-    # Update fonts
-    fonts_dir = docs_path / "fonts"
-    if fonts_dir.is_dir():
-        remote_fonts = _fetch_remote(repo_root, "docs/fonts")
-        # Can't fetch a directory; instead list remote files via git ls-tree
-        try:
-            out = subprocess.check_output(
-                ["git", "ls-tree", "-r", "--name-only", "HEAD", "docs/fonts"],
-                cwd=repo_root,
-                stderr=subprocess.DEVNULL,
-            ).decode("utf-8", errors="replace")
-            for line in out.splitlines():
-                fname = Path(line).name
-                content = _fetch_remote(repo_root, line)
-                if content is not None:
-                    (fonts_dir / fname).write_text(content, encoding="utf-8")
-                    updated.append(f"fonts/{fname}")
-        except (subprocess.CalledProcessError, OSError):
-            pass
-
-    if updated:
-        print(f"   Updated: {', '.join(updated)}")
-    else:
-        print("   No resources updated.")
-
-
-def main(argv=None) -> None:
-    import argparse
-
-    parser = argparse.ArgumentParser(
-        prog="fr-docs update",
-        description="Update fr-docs resources (script.js, style.css, fonts) from the repo.",
-    )
-    parser.add_argument(
-        "--config",
-        help="Path to the configuration JSON file.",
-    )
-    args = parser.parse_args(argv)
-
-    config = load_config(args.config)
-    print(f"🔄 Updating {project_name(config)} resources...")
-    update_resources(config)
-    print("✅ Update complete.")
-
-
-if __name__ == "__main__":
-    main()