docling-core 1.7.2__py3-none-any.whl → 2.0.1__py3-none-any.whl

docling_core/utils/ds_generate_docs.py

@@ -1,144 +0,0 @@
-#
-# Copyright IBM Corp. 2024 - 2024
-# SPDX-License-Identifier: MIT
-#
-
-"""Generate documentation of Docling types in HTML and Markdown.
-
-Example:
-    python docling_core/utils/ds_generate_docs.py /tmp/docling_core_files
-"""
-import argparse
-import glob
-import json
-import os
-from argparse import BooleanOptionalAction
-from pathlib import Path
-from shutil import rmtree
-from typing import Final
-
-from json_schema_for_humans.generate import generate_from_filename
-from json_schema_for_humans.generation_configuration import GenerationConfiguration
-
-from docling_core.utils.ds_generate_jsonschema import generate_json_schema
-
-MODELS: Final = ["Document", "Record", "Generic"]
-
-
-def _prepare_directory(folder: str, clean: bool = False) -> None:
-    """Create a directory or empty its content if it already exists.
-
-    Args:
-        folder: The name of the directory.
-        clean: Whether any existing content in the directory should be removed.
-    """
-    if os.path.isdir(folder):
-        if clean:
-            for path in Path(folder).glob("**/*"):
-                if path.is_file():
-                    path.unlink()
-                elif path.is_dir():
-                    rmtree(path)
-    else:
-        os.makedirs(folder, exist_ok=True)
-
-
-def generate_collection_jsonschema(folder: str):
-    """Generate the JSON schema of Docling collections and export them to a folder.
-
-    Args:
-        folder: The name of the directory.
-    """
-    for item in MODELS:
-        json_schema = generate_json_schema(item)
-        with open(
-            os.path.join(folder, f"{item}.json"), mode="w", encoding="utf8"
-        ) as json_file:
-            json.dump(json_schema, json_file, ensure_ascii=False, indent=2)
-
-
-def generate_collection_html(folder: str):
-    """Generate HTML pages documenting the data model of Docling collections.
-
-    The JSON schemas files need to be in a folder and the generated HTML pages will be
-    written in the same folder.
-
-    Args:
-        folder: The name of the directory.
-    """
-    config = GenerationConfiguration(
-        template_name="js_offline",
-        expand_buttons=True,
-        link_to_reused_ref=False,
-        with_footer=False,
-    )
-
-    for doc_json in glob.glob(os.path.join(folder, "*.json")):
-        doc_html = doc_json.removesuffix(".json") + ".html"
-        generate_from_filename(doc_json, doc_html, config=config)
-
-
-def generate_collection_markdown(folder: str):
-    """Generate Markdown pages documenting the data model of Docling collections.
-
-    The JSON schemas files need to be in a folder and the generated markdown pages will
-    be written in the same folder.
-
-    Args:
-        folder: The name of the directory.
-    """
-    config = GenerationConfiguration(
-        template_name="md_nested",
-        expand_buttons=True,
-        link_to_reused_ref=False,
-        with_footer=False,
-        show_toc=False,
-    )
-
-    for doc_json in glob.glob(os.path.join(folder, "*.json")):
-        doc_html = doc_json.removesuffix(".json") + ".md"
-        generate_from_filename(doc_json, doc_html, config=config)
-
-
-def main() -> None:
-    """Generate the JSON Schema of Docling collections and export documentation."""
-    argparser = argparse.ArgumentParser()
-    argparser.add_argument(
-        "directory",
-        help=(
-            "Directory to generate files. If it exists, any existing content will be"
-            " removed."
-        ),
-    )
-    argparser.add_argument(
-        "--clean",
-        help="Whether any existing content in directory should be removed.",
-        action=BooleanOptionalAction,
-        dest="clean",
-        default=False,
-        required=False,
-    )
-    argparser.add_argument(
-        "--template",
-        action="store",
-        default="markdown",
-        choices=["html", "markdown"],
-        type=str,
-        required=False,
-        dest="template",
-        help="Documentation template.",
-    )
-    args = argparser.parse_args()
-
-    _prepare_directory(args.directory, args.clean)
-
-    generate_collection_jsonschema(args.directory)
-
-    if args.template == "html":
-        generate_collection_html(args.directory)
-    elif args.template == "markdown":
-        generate_collection_markdown(args.directory)
-
-
-if __name__ == "__main__":
-    main()

docling_core-1.7.2.dist-info/entry_points.txt

@@ -1,5 +0,0 @@
-[console_scripts]
-ds_generate_docs=docling_core.utils.ds_generate_docs:main
-ds_generate_jsonschema=docling_core.utils.ds_generate_jsonschema:main
-validate=docling_core.utils.validate:main
-