docs: remove documentation in markdown to support python 3.13

Since json-schema-for-humans dependency does not support python 3.13,
remove the generation of documentation in markdown of main docling types.
Remove 'ds' prefix from documentation scripts.

Signed-off-by: Cesar Berrospi Ramis <[email protected]>

Author: ceberam

.pre-commit-config.yaml

@@ -52,7 +52,7 @@ repos:
     hooks:
       - id: docs
         name: Docs
-        entry: poetry run ds_generate_docs docs
+        entry: poetry run generate_docs docs
         pass_filenames: false
         language: system
         files: '\.py$'

docling_core/utils/ds_generate_docs.py

@@ -0,0 +1,82 @@
+#
+# Copyright IBM Corp. 2024 - 2024
+# SPDX-License-Identifier: MIT
+#
+
+"""Generate documentation of Docling types as JSON schema.
+
+Example:
+    python docling_core/utils/generate_docs.py /tmp/docling_core_files
+"""
+import argparse
+import json
+import os
+from argparse import BooleanOptionalAction
+from pathlib import Path
+from shutil import rmtree
+from typing import Final
+
+from docling_core.utils.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 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,
+    )
+    args = argparser.parse_args()
+
+    _prepare_directory(args.directory, args.clean)
+
+    generate_collection_jsonschema(args.directory)
+
+
+if __name__ == "__main__":
+    main()

docling_core/utils/generate_docs.py

@@ -6,7 +6,7 @@
 """Generate the JSON Schema of pydantic models and export them to files.
 
 Example:
-    python docling_core/utils/ds_generate_jsonschema.py doc.base.TableCell
+    python docling_core/utils/generate_jsonschema.py doc.base.TableCell
 
 """
 import argparse