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

{fr_docs-3.4.0 → fr_docs-3.5.0}/LICENSE.md

@@ -1,131 +1,131 @@
-# PolyForm Noncommercial License 1.0.0
-
-<https://polyformproject.org/licenses/noncommercial/1.0.0>
-
-## Acceptance
-
-In order to get any license under these terms, you must agree
-to them as both strict obligations and conditions to all
-your licenses.
-
-## Copyright License
-
-The licensor grants you a copyright license for the
-software to do everything you might do with the software
-that would otherwise infringe the licensor's copyright
-in it for any permitted purpose.  However, you may
-only distribute the software according to [Distribution
-License](#distribution-license) and make changes or new works
-based on the software according to [Changes and New Works
-License](#changes-and-new-works-license).
-
-## Distribution License
-
-The licensor grants you an additional copyright license
-to distribute copies of the software.  Your license
-to distribute covers distributing the software with
-changes and new works permitted by [Changes and New Works
-License](#changes-and-new-works-license).
-
-## Notices
-
-You must ensure that anyone who gets a copy of any part of
-the software from you also gets a copy of these terms or the
-URL for them above, as well as copies of any plain-text lines
-beginning with `Required Notice:` that the licensor provided
-with the software.  For example:
-
-> Required Notice: Copyright Yoyodyne, Inc. (<http://example.com>)
-
-## Changes and New Works License
-
-The licensor grants you an additional copyright license to
-make changes and new works based on the software for any
-permitted purpose.
-
-## Patent License
-
-The licensor grants you a patent license for the software that
-covers patent claims the licensor can license, or becomes able
-to license, that you would infringe by using the software.
-
-## Noncommercial Purposes
-
-Any noncommercial purpose is a permitted purpose.
-
-## Personal Uses
-
-Personal use for research, experiment, and testing for
-the benefit of public knowledge, personal study, private
-entertainment, hobby projects, amateur pursuits, or religious
-observance, without any anticipated commercial application,
-is use for a permitted purpose.
-
-## Noncommercial Organizations
-
-Use by any charitable organization, educational institution,
-public research organization, public safety or health
-organization, environmental protection organization,
-or government institution is use for a permitted purpose
-regardless of the source of funding or obligations resulting
-from the funding.
-
-## Fair Use
-
-You may have "fair use" rights for the software under the
-law. These terms do not limit them.
-
-## No Other Rights
-
-These terms do not allow you to sublicense or transfer any of
-your licenses to anyone else, or prevent the licensor from
-granting licenses to anyone else.  These terms do not imply
-any other licenses.
-
-## Patent Defense
-
-If you make any written claim that the software infringes or
-contributes to infringement of any patent, your patent license
-for the software granted under these terms ends immediately. If
-your company makes such a claim, your patent license ends
-immediately for work on behalf of your company.
-
-## Violations
-
-The first time you are notified in writing that you have
-violated any of these terms, or done anything with the software
-not covered by your licenses, your licenses can nonetheless
-continue if you come into full compliance with these terms,
-and take practical steps to correct past violations, within
-32 days of receiving notice.  Otherwise, all your licenses
-end immediately.
-
-## No Liability
-
-***As far as the law allows, the software comes as is, without
-any warranty or condition, and the licensor will not be liable
-to you for any damages arising out of these terms or the use
-or nature of the software, under any kind of legal claim.***
-
-## Definitions
-
-The **licensor** is the individual or entity offering these
-terms, and the **software** is the software the licensor makes
-available under these terms.
-
-**You** refers to the individual or entity agreeing to these
-terms.
-
-**Your company** is any legal entity, sole proprietorship,
-or other kind of organization that you work for, plus all
-organizations that have control over, are under the control of,
-or are under common control with that organization.  **Control**
-means ownership of substantially all the assets of an entity,
-or the power to direct its management and policies by vote,
-contract, or otherwise.  Control can be direct or indirect.
-
-**Your licenses** are all the licenses granted to you for the
-software under these terms.
-
-**Use** means anything you do with the software requiring one
-of your licenses.
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose.  However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software.  Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (<http://example.com>)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or religious
+observance, without any anticipated commercial application,
+is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization,
+or government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting
+from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else.  These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice.  Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization.  **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

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

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: fr-docs
-Version: 3.4.0
+Version: 3.5.0
 Summary: Fast static documentation generator with search, versioning, and zero-config setup
-Author: Omena0
+Author-email: Omena0 <omena0mc@gmail.com>
 License: # PolyForm Noncommercial License 1.0.0
         
         <https://polyformproject.org/licenses/noncommercial/1.0.0>

{fr_docs-3.4.0 → fr_docs-3.5.0}/README.md

@@ -1,47 +1,47 @@
-
-# Fr-docs
-
-Generate fast, fully featured, modern documentation pages from markdown for GitHub pages and static hosting.
-
-[![Lint](https://github.com/Omena0/fr-docs/actions/workflows/lint.yml/badge.svg)](https://github.com/Omena0/fr-docs/actions/workflows/lint.yml)
-[![Docs](https://github.com/Omena0/fr-docs/actions/workflows/pages.yml/badge.svg)](https://github.com/Omena0/fr-docs/actions/workflows/pages.yml)
-[![PyPi](https://github.com/Omena0/fr-docs/actions/workflows/publish.yml/badge.svg)](https://github.com/Omena0/fr-docs/actions/workflows/publish.yml)
-[![CodeQL](https://github.com/Omena0/fr-docs/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Omena0/fr-docs/actions/workflows/github-code-scanning/codeql)
-
-## Documentation
-
-- [Getting Started](https://omena0.dev/fr-docs/)
-- [Installation](https://omena0.dev/fr-docs/installation)
-- [Quickstart](https://omena0.dev/fr-docs/quickstart)
-- [Configuration](https://omena0.dev/fr-docs/config.json)
-- [Showcase](https://omena0.dev/fr-docs/showcase)
-
-## Overview
-
-Fr-docs is a generic, configurable documentation builder for Python projects. It converts Markdown source files into a searchable, optimized static HTML site with zero-config setup.
-
-### Key Features
-
-- **Toggleable features**: Disable any features in the config.
-- **Search**: Search pages, headers, source code files, or symbols. Fuzzy matching included.
-- **Markdown features**: Feature-complete markdown features, including:
-  - **Code highlighting**: Highlight code blocks with `fastpylight`
-  - **Copy code blocks**: Copy buttons on multiline code blocks, inline copy code blocks.
-  - **Tables**: Auto convert markdown tables
-  - **Frontmatter metadata**: Title and description as optional frontmatter.
-  - **Hover previews**: Hover a link to see the title and description, hover a code ref to see a code preview.
-  - **Code references**: Link to a source code files, lines, line ranges, or symbols. Automatically generates a clickable code ref.
-  - **Custom tags**: Highlight tags such as `[ext]` automatically across the site.
-- **Auto versioned**: Automatically switch to older documentation based on github tags.<br>
-<sup><sub>(requires site/ to be commited into the repo)</sup></sub>
-- **Auto minification**: Minifies HTML, CSS and JS and inlines Critical CSS.
-- **Same-origin fonts**: Serve fonts from the same origin. Download once before build, serve forever.
-- **Page preloading**: Preload page links for faster browsing.
-- **Configurable elements**: Configure project name, icon, copyright, topbar links, etc.
-
-
-### Projects that use fr-docs
-
-- [Fr-docs](https://omena0.dev/fr-docs/)
-- [PyJavaBridge](https://omena0.dev/PyJavaBridge)
-<sub><sup>(Legacy)</sup></sub>
+
+# Fr-docs
+
+Generate fast, fully featured, modern documentation pages from markdown for GitHub pages and static hosting.
+
+[![Lint](https://github.com/Omena0/fr-docs/actions/workflows/lint.yml/badge.svg)](https://github.com/Omena0/fr-docs/actions/workflows/lint.yml)
+[![Docs](https://github.com/Omena0/fr-docs/actions/workflows/pages.yml/badge.svg)](https://github.com/Omena0/fr-docs/actions/workflows/pages.yml)
+[![PyPi](https://github.com/Omena0/fr-docs/actions/workflows/publish.yml/badge.svg)](https://github.com/Omena0/fr-docs/actions/workflows/publish.yml)
+[![CodeQL](https://github.com/Omena0/fr-docs/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Omena0/fr-docs/actions/workflows/github-code-scanning/codeql)
+
+## Documentation
+
+- [Getting Started](https://omena0.dev/fr-docs/)
+- [Installation](https://omena0.dev/fr-docs/installation)
+- [Quickstart](https://omena0.dev/fr-docs/quickstart)
+- [Configuration](https://omena0.dev/fr-docs/config.json)
+- [Showcase](https://omena0.dev/fr-docs/showcase)
+
+## Overview
+
+Fr-docs is a generic, configurable documentation builder for Python projects. It converts Markdown source files into a searchable, optimized static HTML site with zero-config setup.
+
+### Key Features
+
+- **Toggleable features**: Disable any features in the config.
+- **Search**: Search pages, headers, source code files, or symbols. Fuzzy matching included.
+- **Markdown features**: Feature-complete markdown features, including:
+  - **Code highlighting**: Highlight code blocks with `fastpylight`
+  - **Copy code blocks**: Copy buttons on multiline code blocks, inline copy code blocks.
+  - **Tables**: Auto convert markdown tables
+  - **Frontmatter metadata**: Title and description as optional frontmatter.
+  - **Hover previews**: Hover a link to see the title and description, hover a code ref to see a code preview.
+  - **Code references**: Link to a source code files, lines, line ranges, or symbols. Automatically generates a clickable code ref.
+  - **Custom tags**: Highlight tags such as `[ext]` automatically across the site.
+- **Auto versioned**: Automatically switch to older documentation based on github tags.<br>
+<sup><sub>(requires site/ to be commited into the repo)</sup></sub>
+- **Auto minification**: Minifies HTML, CSS and JS and inlines Critical CSS.
+- **Same-origin fonts**: Serve fonts from the same origin. Download once before build, serve forever.
+- **Page preloading**: Preload page links for faster browsing.
+- **Configurable elements**: Configure project name, icon, copyright, topbar links, etc.
+
+
+### Projects that use fr-docs
+
+- [Fr-docs](https://omena0.dev/fr-docs/)
+- [PyJavaBridge](https://omena0.dev/PyJavaBridge)
+<sub><sup>(Legacy)</sup></sub>

{fr_docs-3.4.0 → fr_docs-3.5.0}/fr_docs/__init__.py

@@ -1,3 +1,3 @@
-"""fr-docs: Fast static documentation generator with search, versioning, and zero-config setup."""
-
-__version__ = "1.0.0"
+"""fr-docs: Fast static documentation generator with search, versioning, and zero-config setup."""
+
+__version__ = "1.0.0"

{fr_docs-3.4.0 → fr_docs-3.5.0}/fr_docs/__main__.py

@@ -1,114 +1,132 @@
-"""Entry point for fr-docs CLI.
-
-Usage:
-    python -m fr_docs build [--production] [--symlink] [--config CONFIG]
-    fr-docs build [--production] [--symlink] [--config CONFIG]
-    python -m fr_docs init [DIR] [config]
-    fr-docs init [DIR] [config]
-"""
-
-import argparse
-import sys
-
-from .build import main as build_main
-from .init import main as init_main
-
-
-def main() -> None:
-    parser = argparse.ArgumentParser(
-        prog="fr-docs",
-        description="Fast static documentation generator",
-    )
-    subparsers = parser.add_subparsers(
-        dest="command",
-        help="Available commands",
-    )
-
-    # Build command
-    build_parser = subparsers.add_parser(
-        "build",
-        help="Build the documentation site",
-    )
-    build_parser.add_argument(
-        "--production",
-        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.",
-    )
-
-    # Init command
-    init_parser = subparsers.add_parser(
-        "init",
-        help="Initialize a new documentation project",
-    )
-    init_parser.add_argument(
-        "dir",
-        nargs="?",
-        default="docs",
-        help="Directory to initialize (default: docs)",
-    )
-    init_parser.add_argument(
-        "target",
-        nargs="?",
-        choices=["config"],
-        default=None,
-        help="Initialize only the configuration.",
-    )
-
-    args = parser.parse_args(sys.argv[1:])
-
-    if args.command == "build":
-        build_argv: list[str] = []
-
-        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)
-        return
-
-    if args.command == "init":
-        # `fr-docs init config` means "initialize config in ./docs".
-        if args.dir == "config" and args.target is None:
-            init_main("docs", True)
-            return
-
-        init_main(args.dir, args.target == "config")
-        return
-
-    # Default to build for backwards compatibility.
-    if len(sys.argv) > 1 and sys.argv[1] in (
-        "--production",
-        "--symlink",
-        "--config",
-        "--help",
-        "-h",
-    ):
-        build_main(sys.argv[1:])
-        return
-
-    parser.print_help()
-    sys.exit(1)
-
-
-if __name__ == "__main__":
-    main()
+"""Entry point for fr-docs CLI.
+
+Usage:
+    python -m fr_docs build [--production] [--symlink] [--config CONFIG]
+    fr-docs build [--production] [--symlink] [--config CONFIG]
+    python -m fr_docs init [DIR] [config|fonts]
+    fr-docs init [DIR] [config|fonts]
+"""
+
+import argparse
+import sys
+
+from .build import main as build_main
+from .init import main as init_main
+from .update import main as update_main
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(
+        prog="fr-docs",
+        description="Fast static documentation generator",
+    )
+    subparsers = parser.add_subparsers(
+        dest="command",
+        help="Available commands",
+    )
+
+    # Build command
+    build_parser = subparsers.add_parser(
+        "build",
+        help="Build the documentation site",
+    )
+    build_parser.add_argument(
+        "--production",
+        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.",
+    )
+
+    # Init command
+    init_parser = subparsers.add_parser(
+        "init",
+        help="Initialize a new documentation project",
+    )
+    init_parser.add_argument(
+        "dir",
+        nargs="?",
+        default="docs",
+        help="Directory to initialize (default: docs)",
+    )
+    init_parser.add_argument(
+        "target",
+        nargs="?",
+        choices=["config", "fonts"],
+        default=None,
+        help="Initialize only the configuration or download fonts.",
+    )
+
+    # Update command
+    update_parser = subparsers.add_parser(
+        "update",
+        help="Update fr-docs resources (script.js, style.css, fonts) from the repo.",
+    )
+    update_parser.add_argument(
+        "--config",
+        help="Path to the configuration JSON file.",
+    )
+
+    args = parser.parse_args(sys.argv[1:])
+
+    if args.command == "build":
+        build_argv: list[str] = []
+
+        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)
+        return
+
+    if args.command == "init":
+        # If first arg is "config" or "fonts" with no explicit dir, use current directory
+        if args.dir in ("config", "fonts") and args.target is None:
+            init_main(".", args.dir)
+            return
+
+        init_main(args.dir, args.target)
+        return
+
+    if args.command == "update":
+        update_argv: list[str] = []
+        if args.config:
+            update_argv.extend(["--config", args.config])
+        update_main(update_argv)
+        return
+
+    # Default to build for backwards compatibility.
+    if len(sys.argv) > 1 and sys.argv[1] in (
+        "--production",
+        "--symlink",
+        "--config",
+        "--help",
+        "-h",
+    ):
+        build_main(sys.argv[1:])
+        return
+
+    parser.print_help()
+    sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()