fr-docs 2.2.0__tar.gz → 2.3.0__tar.gz

{fr_docs-2.2.0 → fr_docs-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fr-docs
-Version: 2.2.0
+Version: 2.3.0
 Summary: Fast static documentation generator with search, versioning, and zero-config setup
 Author: Omena0
 License: # PolyForm Noncommercial License 1.0.0
@@ -175,6 +175,7 @@ Generate fast, fully featured, modern documentation pages from markdown for GitH
 - [Quickstart](https://omena0.dev/fr-docs/quickstart)
 - [Configuration](https://omena0.dev/fr-docs/config.json)
 - [Showcase](https://omena0.dev/fr-docs/showcase)
+- [Pagespeed](https://omena0.dev/fr-docs/pagespeed) — performance metrics
 
 ## Overview
 
@@ -183,12 +184,40 @@ Fr-docs is a generic, configurable documentation builder for Python projects. It
 ### Key Features
 
 - **Config-driven**: All settings defined in `config.json`
+  - Project name, URL, description, and sidebar structure
+  - Search, code references, auto-linking, and related pages
+  - Build options: workers, minification, zstd level, and HTML optimization
+
 - **Zero-config setup**: Works out of the box with sensible defaults
 - **Search**: Full-text search with Zstandard-compressed index
+  - Symbol-level search across all source files
+  - File index for browsing source code
+  - Per-file source highlights with caching
+
 - **Optimized**: HTML minification, critical CSS/JS inlining, Zstd compression
+  - Critical CSS extracted and inlined for both mobile and desktop viewports
+  - JavaScript and CSS minified with `terser` and `html-minifier-next`
+  - Zstd-compressed search index, source files, highlights, and metadata
+  - Adaptive zstd level selection (scans 1..configured, picks the smallest)
+
 - **Multi-environment**: Different configs for production, staging, development
 - **Parallel builds**: Threaded page generation for faster builds
 - **Git integration**: Automatic metadata extraction from git commits
+  - Version options derived from commit messages (e.g. `4D - fix bug` → `4.4.0`)
+  - Commit SHA and message embedded in the version selector
+
+- **Local font serving**: Fonts downloaded at build time and served from the site's own origin
+  - No third-party font round-trips or 404s when Google changes the URL scheme
+  - `font-display: swap` with metric-compatible `font-ascent-descent` fallbacks
+  - Primary body font weight preloaded for faster first paint
+
+- **Sidebar**: Collapsible sections with auto-expansion
+  - The section containing the current page is expanded on load
+  - Single-page sections and single-section sites are expanded by default
+
+- **Inline copy commands**: Prefix inline code with `c` to create copy-on-click links
+- **Code references**: Auto-link bare filename references to their source files
+- **Backlinks and related pages**: Automatically generated navigation between related content
 
 ### Projects that use fr-docs
 

{fr_docs-2.2.0 → fr_docs-2.3.0}/README.md

@@ -15,6 +15,7 @@ Generate fast, fully featured, modern documentation pages from markdown for GitH
 - [Quickstart](https://omena0.dev/fr-docs/quickstart)
 - [Configuration](https://omena0.dev/fr-docs/config.json)
 - [Showcase](https://omena0.dev/fr-docs/showcase)
+- [Pagespeed](https://omena0.dev/fr-docs/pagespeed) — performance metrics
 
 ## Overview
 
@@ -23,12 +24,40 @@ Fr-docs is a generic, configurable documentation builder for Python projects. It
 ### Key Features
 
 - **Config-driven**: All settings defined in `config.json`
+  - Project name, URL, description, and sidebar structure
+  - Search, code references, auto-linking, and related pages
+  - Build options: workers, minification, zstd level, and HTML optimization
+
 - **Zero-config setup**: Works out of the box with sensible defaults
 - **Search**: Full-text search with Zstandard-compressed index
+  - Symbol-level search across all source files
+  - File index for browsing source code
+  - Per-file source highlights with caching
+
 - **Optimized**: HTML minification, critical CSS/JS inlining, Zstd compression
+  - Critical CSS extracted and inlined for both mobile and desktop viewports
+  - JavaScript and CSS minified with `terser` and `html-minifier-next`
+  - Zstd-compressed search index, source files, highlights, and metadata
+  - Adaptive zstd level selection (scans 1..configured, picks the smallest)
+
 - **Multi-environment**: Different configs for production, staging, development
 - **Parallel builds**: Threaded page generation for faster builds
 - **Git integration**: Automatic metadata extraction from git commits
+  - Version options derived from commit messages (e.g. `4D - fix bug` → `4.4.0`)
+  - Commit SHA and message embedded in the version selector
+
+- **Local font serving**: Fonts downloaded at build time and served from the site's own origin
+  - No third-party font round-trips or 404s when Google changes the URL scheme
+  - `font-display: swap` with metric-compatible `font-ascent-descent` fallbacks
+  - Primary body font weight preloaded for faster first paint
+
+- **Sidebar**: Collapsible sections with auto-expansion
+  - The section containing the current page is expanded on load
+  - Single-page sections and single-section sites are expanded by default
+
+- **Inline copy commands**: Prefix inline code with `c` to create copy-on-click links
+- **Code references**: Auto-link bare filename references to their source files
+- **Backlinks and related pages**: Automatically generated navigation between related content
 
 ### Projects that use fr-docs
 

{fr_docs-2.2.0 → fr_docs-2.3.0}/fr_docs/__main__.py

@@ -1,8 +1,8 @@
 """Entry point for fr-docs CLI.
 
 Usage:
-    python -m fr_docs build [--production] [--config CONFIG]
-    fr-docs build [--production] [--config CONFIG]
+    python -m fr_docs build [--production] [--symlink] [--config CONFIG]
+    fr-docs build [--production] [--symlink] [--config CONFIG]
     python -m fr_docs init [--dir DIR]
     fr-docs init [--dir DIR]
 """
@@ -27,6 +27,14 @@ def main():
         action="store_true",
         help="Rewrite internal links to site-root absolute paths for deployed docs.",
     )
+    build_parser.add_argument(
+        "--symlink",
+        action="store_true",
+        help="Create a {site_prefix}/ symlink dir under site/ so a local "
+        "production build can be opened in a browser. Off by default: in "
+        "CI the whole docs/site/ tree is deployed as-is, and a nested "
+        "fr-docs/ symlink folder would show up as omena0.dev/fr-docs/fr-docs/.",
+    )
     build_parser.add_argument(
         "--config",
         help="Path to the configuration JSON file.",
@@ -51,6 +59,8 @@ def main():
         build_argv = []
         if args.production:
             build_argv.append("--production")
+        if args.symlink:
+            build_argv.append("--symlink")
         if args.config:
             build_argv.extend(["--config", args.config])
         build_main(build_argv)
@@ -60,6 +70,7 @@ def main():
         # Default to build for backwards compatibility
         if len(sys.argv) > 1 and sys.argv[1] in (
             "--production",
+            "--symlink",
             "--config",
             "--help",
             "-h",

{fr_docs-2.2.0 → fr_docs-2.3.0}/fr_docs/build.py

@@ -617,7 +617,7 @@ def main(argv=None):
         except Exception as e:  # noqa: BLE001
             print(f"   ✗ Minification failed: {e}")
 
-        # Create a {site_prefix}/ directory under site/ and symlink every
+# Create a {site_prefix}/ directory under site/ and symlink every
         # file into it, so a production build works locally (the HTML
         # references absolute paths like /fr-docs/style.css). Without
         # this, running `python -m fr_docs build --production` and then
@@ -636,9 +636,7 @@ def main(argv=None):
                 for f in sorted(Path(config["_out_dir"]).iterdir()):
                     if f.is_file() and not f.name.startswith("."):
                         (prefix_dir / f.name).symlink_to(f.resolve())
-                print(
-                    f"   ✓ Symlinked {len(list(prefix_dir.iterdir()))} files into {prefix}/"
-                )
+                print(f"   ✓ Symlinked {len(list(prefix_dir.iterdir()))} files into {prefix}/")
             except OSError as e:
                 print(f"   ✗ Failed to create {prefix}/ symlinks: {e}")
 

{fr_docs-2.2.0 → fr_docs-2.3.0}/fr_docs/html_pipeline.py

@@ -354,9 +354,7 @@ def optimize_all_pages(config):
     # paths first, run critical, then restore the absolute paths in
     # the inlined output.
     site_prefix = normalized_site_prefix(config)
-    stripped_prefix = (
-        site_prefix.rstrip("/") if site_prefix and site_prefix != "/" else None
-    )
+    stripped_prefix = site_prefix.rstrip("/") if site_prefix and site_prefix != "/" else None
     backed_up = []
 
     try:
@@ -375,7 +373,7 @@ def optimize_all_pages(config):
                 # Strip the site prefix so href=/fr-docs/style.css
                 # becomes href=style.css (relative to the HTML file).
                 rewritten = prefix_pat.sub(
-                    lambda m: f"href={m.group(1)}{m.group(2)}{m.group(1)}",
+                    lambda m: f'href={m.group(1)}{m.group(2)}{m.group(1)}',
                     raw,
                 )
                 html_file.write_text(rewritten, encoding="utf-8")
@@ -487,7 +485,7 @@ def add_internal_prefetch_links(html_text, config):
     def _repl(m):
         attrs = m.group("attrs")
         # Skip links that already declare a rel attribute
-        if re.search(r"\brel\s*=", attrs, re.IGNORECASE):
+        if re.search(r'\brel\s*=', attrs, re.IGNORECASE):
             return m.group(0)
         hm = href_re.search(attrs)
         if not hm:

{fr_docs-2.2.0 → fr_docs-2.3.0}/fr_docs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fr-docs
-Version: 2.2.0
+Version: 2.3.0
 Summary: Fast static documentation generator with search, versioning, and zero-config setup
 Author: Omena0
 License: # PolyForm Noncommercial License 1.0.0
@@ -175,6 +175,7 @@ Generate fast, fully featured, modern documentation pages from markdown for GitH
 - [Quickstart](https://omena0.dev/fr-docs/quickstart)
 - [Configuration](https://omena0.dev/fr-docs/config.json)
 - [Showcase](https://omena0.dev/fr-docs/showcase)
+- [Pagespeed](https://omena0.dev/fr-docs/pagespeed) — performance metrics
 
 ## Overview
 
@@ -183,12 +184,40 @@ Fr-docs is a generic, configurable documentation builder for Python projects. It
 ### Key Features
 
 - **Config-driven**: All settings defined in `config.json`
+  - Project name, URL, description, and sidebar structure
+  - Search, code references, auto-linking, and related pages
+  - Build options: workers, minification, zstd level, and HTML optimization
+
 - **Zero-config setup**: Works out of the box with sensible defaults
 - **Search**: Full-text search with Zstandard-compressed index
+  - Symbol-level search across all source files
+  - File index for browsing source code
+  - Per-file source highlights with caching
+
 - **Optimized**: HTML minification, critical CSS/JS inlining, Zstd compression
+  - Critical CSS extracted and inlined for both mobile and desktop viewports
+  - JavaScript and CSS minified with `terser` and `html-minifier-next`
+  - Zstd-compressed search index, source files, highlights, and metadata
+  - Adaptive zstd level selection (scans 1..configured, picks the smallest)
+
 - **Multi-environment**: Different configs for production, staging, development
 - **Parallel builds**: Threaded page generation for faster builds
 - **Git integration**: Automatic metadata extraction from git commits
+  - Version options derived from commit messages (e.g. `4D - fix bug` → `4.4.0`)
+  - Commit SHA and message embedded in the version selector
+
+- **Local font serving**: Fonts downloaded at build time and served from the site's own origin
+  - No third-party font round-trips or 404s when Google changes the URL scheme
+  - `font-display: swap` with metric-compatible `font-ascent-descent` fallbacks
+  - Primary body font weight preloaded for faster first paint
+
+- **Sidebar**: Collapsible sections with auto-expansion
+  - The section containing the current page is expanded on load
+  - Single-page sections and single-section sites are expanded by default
+
+- **Inline copy commands**: Prefix inline code with `c` to create copy-on-click links
+- **Code references**: Auto-link bare filename references to their source files
+- **Backlinks and related pages**: Automatically generated navigation between related content
 
 ### Projects that use fr-docs
 

{fr_docs-2.2.0 → fr_docs-2.3.0}/pyproject.toml

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