NeoAnd/Docling
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: various minor docs fixes (#169)

Browse Source 
Signed-off-by: Panos Vagenas <35837085+vagenas@users.noreply.github.com>
This commit is contained in:
Panos Vagenas 2024-10-22 15:29:36 +02:00 committed by GitHub
parent fa5f94ec10
commit b8d2286dd1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 10 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,6 +1,6 @@
<p align="center"> <p align="center">
<a href="https://github.com/ds4sd/docling"> <a href="https://github.com/ds4sd/docling">
<img loading="lazy" alt="Docling" src="docs/assets/docling_processing.png" width="100%"/> <img loading="lazy" alt="Docling" src="https://github.com/DS4SD/docling/raw/main/docs/assets/docling_processing.png" width="100%"/>
</a> </a>
</p> </p>
@ -50,7 +50,7 @@ To convert individual documents, use `convert()`, for example:
```python ```python
from docling.document_converter import DocumentConverter from docling.document_converter import DocumentConverter
source = "https://arxiv.org/pdf/2408.09869" # PDF path or URL source = "https://arxiv.org/pdf/2408.09869" # document per local path or URL
converter = DocumentConverter() converter = DocumentConverter()
result = converter.convert(source) result = converter.convert(source)
print(result.document.export_to_markdown()) # output: "## Docling Technical Report[...]" print(result.document.export_to_markdown()) # output: "## Docling Technical Report[...]"

9
docs/examples/minimal.py
View File

@ -1,10 +1,7 @@
from docling.document_converter import DocumentConverter from docling.document_converter import DocumentConverter
source = "https://arxiv.org/pdf/2408.09869" # PDF path or URL source = "https://arxiv.org/pdf/2408.09869" # document per local path or URL
converter = DocumentConverter() converter = DocumentConverter()
result = converter.convert(source) result = converter.convert(source)
print( print(result.document.export_to_markdown())
result.document.export_to_markdown() # output: ## Docling Technical Report [...]"
) # output: ## Docling Technical Report [...]"
# if the legacy output is needed, use this version
# print(result.legacy_document.export_to_markdown()) # output: ## Docling Technical Report [...]"

4
docs/index.md
View File

@ -1,9 +1,7 @@
# Docling # Docling
<p align="center"> <p align="center">
<a href="https://ds4sd.github.io/docling/"> <img loading="lazy" alt="Docling" src="assets/docling_processing.png" width="100%" />
<img loading="lazy" alt="Docling" src="assets/logo.png" width="150" />
</a>
</p> </p>

8
docs/usage.md
View File

@ -27,10 +27,10 @@ To see all available options (export formats etc.) run `docling --help`.
<details> <details>
<summary><b>CLI reference</b></summary> <summary><b>CLI reference</b></summary>
Here are the available options as of this writing (for an up-to-date listing, run `docling --help`): Here are the available options as of this writing (for an up-to-date listing, run `docling --help`):
```console ```console
$ docling --help $ docling --help
Usage: docling [OPTIONS] source Usage: docling [OPTIONS] source
@ -57,7 +57,7 @@ To see all available options (export formats etc.) run `docling --help`.
│ --version Show version information. │ │ --version Show version information. │
│ --help Show this message and exit. │ │ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
``` ```
</details> </details>