Julia Pap
cc5e3cee74
* docs: add docstrings for DocumentConverter Signed-off-by: Julia Pap <papjuli@gmail.com> * Apply suggestions from code review Improve docstrings in DocumentConverter Co-authored-by: Cesar Berrospi Ramis <75900930+ceberam@users.noreply.github.com> Signed-off-by: Julia Pap <papjuli@gmail.com> * docs: improve docstring formatting and wording in DocumentConverter * docs: show init method in document converter reference * docs: change back indents to 4x in DocumentConverter docstrings griffe was issuing warnings of confusing indentation * docs: clarify `max_num_pages` and `page_range` args in `DocumentConverter` methods * docs: fix some Yields and Returns in DocumentConverter docstrings * DCO Remediation Commit for Julia Pap <papjuli@gmail.com> I, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit:cf2ea4e0f0I, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit:57446af168I, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit:5d613edb8cI, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit:b195281f56I, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit:5d4a3af5d5Signed-off-by: Julia Pap <papjuli@gmail.com> * docs: ignore init description, rephrased docstrings Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com> --------- Signed-off-by: Julia Pap <papjuli@gmail.com> Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com> Co-authored-by: Cesar Berrospi Ramis <75900930+ceberam@users.noreply.github.com> Co-authored-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>
1.3 KiB
Vendored
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 docstring_options: ignore_init_summary: true show_docstring_attributes: false show_attribute_values: false 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