Docling/docs
nuridol 6efa96c983
feat: add support for ocrmac OCR engine on macOS (#276)
* feat: add support for `ocrmac` OCR engine on macOS

- Integrates `ocrmac` as an OCR engine option for macOS users.
- Adds configuration options and dependencies for `ocrmac`.
- Updates documentation to reflect new engine support.

This change allows macOS users to utilize `ocrmac` for improved OCR performance and compatibility.

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* updated the poetry lock

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* Fix linting issues, update CLI docs, and add error for ocrmac use on non-Mac systems

- Resolved formatting and linting issues
- Updated `--ocr-engine` CLI option documentation for `ocrmac`
- Added RuntimeError for attempts to use `ocrmac` on non-Mac platforms

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* feat: add support for `ocrmac` OCR engine on macOS

- Integrates `ocrmac` as an OCR engine option for macOS users.
- Adds configuration options and dependencies for `ocrmac`.
- Updates documentation to reflect new engine support.

This change allows macOS users to utilize `ocrmac` for improved OCR performance and compatibility.

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* docs: update examples and installation for ocrmac support

- Added `OcrMacOptions` to `custom_convert.py` and `full_page_ocr.py` examples.
- Included usage comments and examples for `OcrMacOptions` in OCR pipelines.
- Updated installation guide to include instructions for installing `ocrmac`, noting macOS version requirements (10.15+).
- Highlighted that `ocrmac` leverages Apple's Vision framework as an OCR backend.

This enhances documentation for users working on macOS to leverage `ocrmac` effectively.

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

* fix: update `ocrmac` dependency with macOS-specific marker

- Added `sys_platform == 'darwin'` marker to the `ocrmac` dependency in `pyproject.toml` to specify macOS compatibility.
- Updated the content hash in `poetry.lock` to reflect the changes.

This ensures the `ocrmac` dependency is only installed on macOS systems.

Signed-off-by: Suhwan Seo <nuridol@gmail.com>

---------

Signed-off-by: Suhwan Seo <nuridol@gmail.com>
Co-authored-by: Suhwan Seo <nuridol@gmail.com>
2024-11-20 12:51:19 +01:00
..
assets docs: add architecture outline (#341) 2024-11-15 12:52:41 +01:00
concepts docs: add architecture outline (#341) 2024-11-15 12:52:41 +01:00
examples feat: add support for ocrmac OCR engine on macOS (#276) 2024-11-20 12:51:19 +01:00
integrations docs: add architecture outline (#341) 2024-11-15 12:52:41 +01:00
overrides feat!: Docling v2 (#117) 2024-10-16 21:02:03 +02:00
stylesheets docs: introduce docs site (#141) 2024-10-14 14:13:13 +02:00
cli.md docs: add automatic generation of CLI reference (#325) 2024-11-15 13:18:17 +01:00
index.md docs: update badges & credits (#248) 2024-11-05 13:57:06 +01:00
installation.md feat: add support for ocrmac OCR engine on macOS (#276) 2024-11-20 12:51:19 +01:00
usage.md docs: add automatic generation of CLI reference (#325) 2024-11-15 13:18:17 +01:00
v2.md docs: fixed typo in v2 example v2 (#378) 2024-11-19 16:27:19 +01:00