feat: improve markdown export of DoclingDocument (#50)

* feat: improve export of doclingdocument

Signed-off-by: Peter Staar <[email protected]>

* added indented text

Signed-off-by: Peter Staar <[email protected]>

* updated the labels in to_indented_text

Signed-off-by: Peter Staar <[email protected]>

* updated the export of text

Signed-off-by: Peter Staar <[email protected]>

* updated the export of indented text

Signed-off-by: Peter Staar <[email protected]>

* fixed the mypy and flake8

Signed-off-by: Peter Staar <[email protected]>

* updated the export to markdown leveraging the hierarchy

Signed-off-by: Peter Staar <[email protected]>

* fixed the mypy and flake

Signed-off-by: Peter Staar <[email protected]>

* updated the export_to_markdown_v2

Signed-off-by: Peter Staar <[email protected]>

* updated the export_to_markdown_v2 (2)

Signed-off-by: Peter Staar <[email protected]>

* adding new tests

Signed-off-by: Peter Staar <[email protected]>

* fixed the test

Signed-off-by: Peter Staar <[email protected]>

* fixed the precommits

Signed-off-by: Peter Staar <[email protected]>

* fixed the title and section-headers in document

Signed-off-by: Peter Staar <[email protected]>

* indented all

Signed-off-by: Peter Staar <[email protected]>

* Cleanup markdown v2 export

Signed-off-by: Christoph Auer <[email protected]>

* Remove unnecessary methods

Signed-off-by: Christoph Auer <[email protected]>

* Mark methods private

Signed-off-by: Christoph Auer <[email protected]>

* fixed the extra parameters for export_to_markdown

Signed-off-by: Peter Staar <[email protected]>

* Add ImageRefMode arg

Signed-off-by: Christoph Auer <[email protected]>

* fixed the strict_text argument

Signed-off-by: Peter Staar <[email protected]>

* fixed the indent of the lists

Signed-off-by: Peter Staar <[email protected]>

* make table output explicit

Signed-off-by: Peter Staar <[email protected]>

* Improve list rendering code.

Signed-off-by: Christoph Auer <[email protected]>

* Improve empty lines between sections and elements

Signed-off-by: Christoph Auer <[email protected]>

* Add text/markdown mime

Signed-off-by: Christoph Auer <[email protected]>

* Fix indentation spaces on markdown lists

Signed-off-by: Christoph Auer <[email protected]>

* make list indent a parameter with default 4

Signed-off-by: Peter Staar <[email protected]>

* make list indent a parameter with default 4 (reindented)

Signed-off-by: Peter Staar <[email protected]>

* Fix separation of multiple adjacent lists on same level

Signed-off-by: Christoph Auer <[email protected]>

* Correct comments

Signed-off-by: Christoph Auer <[email protected]>

---------

Signed-off-by: Peter Staar <[email protected]>
Signed-off-by: Christoph Auer <[email protected]>
Co-authored-by: Christoph Auer <[email protected]>

Author: PeterStaar-IBM

.flake8

@@ -2,7 +2,7 @@
 per-file-ignores = __init__.py:F401
 max-line-length = 88
 exclude = test/*
-max-complexity = 18
+max-complexity = 25
 docstring-convention = google
 ignore = W503,E203
 classmethod-decorators = classmethod,validator

docling_core/types/doc/__init__.py

@@ -5,7 +5,7 @@
 
 """Package for models defined by the Document type."""
 
-from .base import BoundingBox, CoordOrigin, Size
+from .base import BoundingBox, CoordOrigin, ImageRefMode, Size
 from .document import (
     DocItem,
     DoclingDocument,

docling_core/types/doc/base.py

@@ -7,6 +7,13 @@
 from pydantic import BaseModel
 
 
+class ImageRefMode(str, Enum):
+    """ImageRefMode."""
+
+    PLACEHOLDER = "placeholder"
+    EMBEDDED = "embedded"
+
+
 class CoordOrigin(str, Enum):
     """CoordOrigin."""