@@ -7,6 +7,43 @@ can be enabled with `do_xyz = True`.
77
88This is an automatic generated API reference of the all the pipeline options available in Docling.
99
10+ ## LaTeX TikZ Rendering
11+
12+ Docling's LaTeX backend can optionally render ` tikzpicture ` environments into
13+ images using the Tectonic engine.
14+
15+ ### Backend options
16+
17+ ` LatexBackendOptions ` supports the following TikZ-related options:
18+
19+ - ` tikz_engine `
20+ Set to ` "tectonic" ` to enable optional TikZ rendering.
21+ - ` allow_tikz_engine_download `
22+ Allows the LaTeX backend to download the Tectonic binary when TikZ rendering
23+ is enabled and no local binary is available.
24+ - ` tikz_engine_timeout `
25+ Sets the timeout, in seconds, for rendering a single TikZ diagram.
26+ - ` tikz_engine_allow_shell_escape `
27+ Defaults to ` False ` . Enable this only when required by the input document,
28+ since shell escape is less safe for untrusted LaTeX sources.
29+
30+ ### CLI flags
31+
32+ The CLI exposes the same behavior with these flags:
33+
34+ - ` --tikz-engine ` / ` -T `
35+ - ` --no-tikz-engine-download `
36+ - ` --tikz-engine-timeout `
37+ - ` --tikz-shell-escape `
38+
39+ ### Fallback behavior
40+
41+ - When Tectonic compilation succeeds, the TikZ diagram is rasterized and stored
42+ as an image.
43+ - When compilation fails, times out, produces no PDF, or rasterization fails,
44+ Docling preserves the original TikZ source as fallback code metadata instead
45+ of dropping the figure.
46+
1047
1148::: docling.datamodel.pipeline_options
1249 handler: python
0 commit comments