-
Notifications
You must be signed in to change notification settings - Fork 837
/
mkdocs.yml
136 lines (130 loc) Β· 4.15 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
site_name: Docling
site_url: https://ds4sd.github.io/docling/
repo_name: DS4SD/docling
repo_url: https://github.com/DS4SD/docling
theme:
name: material
custom_dir: docs/overrides
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
scheme: default
primary: black
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/brightness-4
name: Switch to system preference
logo: assets/logo.png
favicon: assets/logo.png
features:
- content.tabs.link
- content.code.annotate
- content.code.copy
- announce.dismiss
- navigation.footer
- navigation.tabs
- navigation.indexes # <= if set, each "section" can have its own page, if index.md is used
- navigation.instant
- navigation.instant.prefetch
# - navigation.instant.preview
- navigation.instant.progress
- navigation.path
- navigation.sections # <=
- navigation.top
- navigation.tracking
- search.suggest
- toc.follow
nav:
- Home:
- "Docling": index.md
- Installation: installation.md
- Usage: usage.md
- FAQ: faq.md
- Docling v2: v2.md
- Concepts:
- Concepts: concepts/index.md
- Architecture: concepts/architecture.md
- Docling Document: concepts/docling_document.md
- Chunking: concepts/chunking.md
- Examples:
- Examples: examples/index.md
- Conversion:
- "Simple conversion": examples/minimal.py
- "Custom conversion": examples/custom_convert.py
- "Batch conversion": examples/batch_convert.py
- "Multi-format conversion": examples/run_with_formats.py
- "Figure export": examples/export_figures.py
- "Figure enrichment": examples/develop_picture_enrichment.py
- "Table export": examples/export_tables.py
- "Multimodal export": examples/export_multimodal.py
- "Force full page OCR": examples/full_page_ocr.py
- "Accelerator options": examples/run_with_accelerator.py
- Chunking:
- "Hybrid chunking": examples/hybrid_chunking.ipynb
- RAG / QA:
- "RAG with Haystack": examples/rag_haystack.ipynb
- "RAG with LlamaIndex π¦": examples/rag_llamaindex.ipynb
- "RAG with LangChain π¦π": examples/rag_langchain.ipynb
- "RAG with Weaviate": examples/rag_weaviate.ipynb
- "Hybrid RAG with Qdrant": examples/hybrid_rag_qdrant.ipynb
- Integrations:
- Integrations: integrations/index.md
- "π Bee": integrations/bee.md
- "Cloudera": integrations/cloudera.md
- "Data Prep Kit": integrations/data_prep_kit.md
- "DocETL": integrations/docetl.md
- "Haystack": integrations/haystack.md
- "πΆ InstructLab": integrations/instructlab.md
- "Kotaemon": integrations/kotaemon.md
- "π¦ LlamaIndex": integrations/llamaindex.md
- "Prodigy": integrations/prodigy.md
- "RHEL AI": integrations/rhel_ai.md
- "spaCy": integrations/spacy.md
- "txtai": integrations/txtai.md
- "Vectara": integrations/vectara.md
# - "LangChain π¦π": integrations/langchain.md
- Reference:
- Python API:
- Document Converter: reference/document_converter.md
- Pipeline options: reference/pipeline_options.md
- Docling Document: reference/docling_document.md
- CLI:
- CLI reference: reference/cli.md
markdown_extensions:
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- admonition
- pymdownx.details
- attr_list
- mkdocs-click
plugins:
- search
- mkdocs-jupyter
- mkdocstrings:
default_handler: python
options:
extensions:
- griffe_pydantic:
schema: true
preload_modules:
- docling
- docling_core
extra_css:
- stylesheets/extra.css