From 84e45d71910fe8734891120f172608eeef2f36cc Mon Sep 17 00:00:00 2001 From: Gustavo Lima Date: Fri, 11 Jul 2025 16:36:49 +0100 Subject: [PATCH] docs: fix README getting started to reflect single document conversion --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c53e7b79..23d0a47a 100644 --- a/README.md +++ b/README.md @@ -58,15 +58,15 @@ More [detailed installation instructions](https://docling-project.github.io/docl ## Getting started -To convert individual documents with python, use `convert()`, for example: +To convert individual documents with python, use `convert_single()`, for example: ```python from docling.document_converter import DocumentConverter source = "https://arxiv.org/pdf/2408.09869" # document per local path or URL converter = DocumentConverter() -result = converter.convert(source) -print(result.document.export_to_markdown()) # output: "## Docling Technical Report[...]" +result = converter.convert_single(source) +print(result.render_as_markdown()) # output: "## Docling Technical Report[...]" ``` More [advanced usage options](https://docling-project.github.io/docling/usage/) are available in