mirror of
https://github.com/DS4SD/docling.git
synced 2025-12-08 20:58:11 +00:00
docs: add automatic api reference (#475)
Signed-off-by: Michele Dolfi <dol@zurich.ibm.com>
This commit is contained in:
52
docs/api_reference/docling_document.md
Normal file
52
docs/api_reference/docling_document.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Docling Document
|
||||
|
||||
This is an automatic generated API reference of the DoclingDocument type.
|
||||
|
||||
::: docling_core.types.doc
|
||||
handler: python
|
||||
options:
|
||||
members:
|
||||
- DoclingDocument
|
||||
- DocumentOrigin
|
||||
- DocItem
|
||||
- DocItemLabel
|
||||
- ProvenanceItem
|
||||
- GroupItem
|
||||
- GroupLabel
|
||||
- NodeItem
|
||||
- PageItem
|
||||
- FloatingItem
|
||||
- TextItem
|
||||
- TableItem
|
||||
- TableCell
|
||||
- TableData
|
||||
- TableCellLabel
|
||||
- KeyValueItem
|
||||
- SectionHeaderItem
|
||||
- PictureItem
|
||||
- ImageRef
|
||||
- PictureClassificationClass
|
||||
- PictureClassificationData
|
||||
- RefItem
|
||||
- BoundingBox
|
||||
- CoordOrigin
|
||||
- ImageRefMode
|
||||
- Size
|
||||
show_if_no_docstring: true
|
||||
show_submodules: true
|
||||
docstring_section_style: list
|
||||
filters: ["!^_"]
|
||||
heading_level: 2
|
||||
show_root_toc_entry: true
|
||||
inherited_members: true
|
||||
merge_init_into_class: true
|
||||
separate_signature: true
|
||||
show_root_heading: true
|
||||
show_root_full_path: false
|
||||
show_signature_annotations: true
|
||||
show_source: false
|
||||
show_symbol_type_heading: true
|
||||
show_symbol_type_toc: true
|
||||
show_labels: false
|
||||
signature_crossrefs: true
|
||||
summary: true
|
||||
38
docs/api_reference/document_converter.md
Normal file
38
docs/api_reference/document_converter.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Document converter
|
||||
|
||||
This is an automatic generated API reference of the main components of Docling.
|
||||
|
||||
::: docling.document_converter
|
||||
handler: python
|
||||
options:
|
||||
members:
|
||||
- DocumentConverter
|
||||
- ConversionResult
|
||||
- ConversionStatus
|
||||
- FormatOption
|
||||
- InputFormat
|
||||
- PdfFormatOption
|
||||
- ImageFormatOption
|
||||
- StandardPdfPipeline
|
||||
- WordFormatOption
|
||||
- PowerpointFormatOption
|
||||
- MarkdownFormatOption
|
||||
- AsciiDocFormatOption
|
||||
- HTMLFormatOption
|
||||
- SimplePipeline
|
||||
show_if_no_docstring: true
|
||||
show_submodules: true
|
||||
docstring_section_style: list
|
||||
filters: ["!^_"]
|
||||
heading_level: 2
|
||||
inherited_members: true
|
||||
merge_init_into_class: true
|
||||
separate_signature: true
|
||||
show_root_heading: true
|
||||
show_root_full_path: false
|
||||
show_signature_annotations: true
|
||||
show_source: false
|
||||
show_symbol_type_heading: true
|
||||
show_symbol_type_toc: true
|
||||
signature_crossrefs: true
|
||||
summary: true
|
||||
36
docs/api_reference/pipeline_options.md
Normal file
36
docs/api_reference/pipeline_options.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Pipeline options
|
||||
|
||||
Pipeline options allow to customize the execution of the models during the conversion pipeline.
|
||||
This includes options for the OCR engines, the table model as well as enrichment options which
|
||||
can be enabled with `do_xyz = True`.
|
||||
|
||||
|
||||
This is an automatic generated API reference of the all the pipeline options available in Docling.
|
||||
|
||||
|
||||
::: docling.datamodel.pipeline_options
|
||||
handler: python
|
||||
options:
|
||||
show_if_no_docstring: true
|
||||
show_submodules: true
|
||||
docstring_section_style: list
|
||||
filters: ["!^_"]
|
||||
heading_level: 2
|
||||
inherited_members: true
|
||||
merge_init_into_class: true
|
||||
separate_signature: true
|
||||
show_root_heading: true
|
||||
show_root_full_path: false
|
||||
show_signature_annotations: true
|
||||
show_source: false
|
||||
show_symbol_type_heading: true
|
||||
show_symbol_type_toc: true
|
||||
signature_crossrefs: true
|
||||
summary: true
|
||||
|
||||
<!-- ::: docling.document_converter.DocumentConverter
|
||||
handler: python
|
||||
options:
|
||||
show_if_no_docstring: true
|
||||
show_submodules: true -->
|
||||
|
||||
Reference in New Issue
Block a user