2025-04-21 05:05:53 +00:00
<!DOCTYPE html>
< html lang = "en" data-content_root = "./" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > API Reference — TexTeller documentation< / title >
< script data-cfasync = "false" >
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
< / script >
<!-- Loaded before other Sphinx assets -->
< link href = "_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel = "stylesheet" / >
< link href = "_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel = "stylesheet" / >
< link href = "_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel = "stylesheet" / >
< link href = "_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel = "stylesheet" / >
< link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" / >
< link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" / >
< link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" / >
< link rel = "stylesheet" type = "text/css" href = "_static/pygments.css?v=8f2a1f02" / >
< link rel = "stylesheet" type = "text/css" href = "_static/styles/sphinx-book-theme.css?v=eba8b062" / >
< link rel = "stylesheet" type = "text/css" href = "_static/copybutton.css?v=76b2166b" / >
< link rel = "stylesheet" type = "text/css" href = "_static/sphinx-design.min.css?v=95c83b7e" / >
<!-- Pre - loaded scripts that we'll load fully later -->
< link rel = "preload" as = "script" href = "_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" / >
< link rel = "preload" as = "script" href = "_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" / >
< script src = "_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b" > < / script >
< script src = "_static/documentation_options.js?v=9eb32ce0" > < / script >
< script src = "_static/doctools.js?v=9bcbadda" > < / script >
< script src = "_static/sphinx_highlight.js?v=dc90522c" > < / script >
< script src = "_static/clipboard.min.js?v=a7894cd8" > < / script >
< script src = "_static/copybutton.js?v=f281be69" > < / script >
< script src = "_static/scripts/sphinx-book-theme.js?v=887ef09a" > < / script >
< script src = "_static/design-tabs.js?v=f930bc37" > < / script >
< script crossorigin = "anonymous" integrity = "sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src = "https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js" > < / script >
< script > DOCUMENTATION _OPTIONS . pagename = 'api' ; < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "prev" title = "TexTeller Documentation" href = "index.html" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< meta name = "docsearch:language" content = "en" / >
< / head >
< body data-bs-spy = "scroll" data-bs-target = ".bd-toc-nav" data-offset = "180" data-bs-root-margin = "0px 0px -60%" data-default-mode = "" >
< div id = "pst-skip-link" class = "skip-link d-print-none" > < a href = "#main-content" > Skip to main content< / a > < / div >
< div id = "pst-scroll-pixel-helper" > < / div >
< button type = "button" class = "btn rounded-pill" id = "pst-back-to-top" >
< i class = "fa-solid fa-arrow-up" > < / i > Back to top< / button >
< input type = "checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
< label class = "overlay overlay-primary" for = "pst-primary-sidebar-checkbox" > < / label >
< input type = "checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
< label class = "overlay overlay-secondary" for = "pst-secondary-sidebar-checkbox" > < / label >
< div class = "search-button__wrapper" >
< div class = "search-button__overlay" > < / div >
< div class = "search-button__search-container" >
< form class = "bd-search d-flex align-items-center"
action="search.html"
method="get">
< i class = "fa-solid fa-magnifying-glass" > < / i >
< input type = "search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
< span class = "search-button__kbd-shortcut" > < kbd class = "kbd-shortcut__modifier" > Ctrl< / kbd > +< kbd > K< / kbd > < / span >
< / form > < / div >
< / div >
< div class = "pst-async-banner-revealer d-none" >
< aside id = "bd-header-version-warning" class = "d-none d-print-none" aria-label = "Version warning" > < / aside >
< / div >
< header class = "bd-header navbar navbar-expand-lg bd-navbar d-print-none" >
< / header >
< div class = "bd-container" >
< div class = "bd-container__inner bd-page-width" >
< div class = "bd-sidebar-primary bd-sidebar" >
< div class = "sidebar-header-items sidebar-primary__section" >
< / div >
< div class = "sidebar-primary-items__start sidebar-primary__section" >
< div class = "sidebar-primary-item" >
< a class = "navbar-brand logo" href = "index.html" >
< img src = "_static/logo.svg" class = "logo__image only-light" alt = "TexTeller documentation - Home" / >
< script > document . write ( ` <img src="_static/logo.svg" class="logo__image only-dark" alt="TexTeller documentation - Home"/> ` ) ; < / script >
< / a > < / div >
< div class = "sidebar-primary-item" >
< script >
document.write(`
< button class = "btn search-button-field search-button__button" title = "Search" aria-label = "Search" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< i class = "fa-solid fa-magnifying-glass" > < / i >
< span class = "search-button__default-text" > Search< / span >
< span class = "search-button__kbd-shortcut" > < kbd class = "kbd-shortcut__modifier" > Ctrl< / kbd > +< kbd class = "kbd-shortcut__modifier" > K< / kbd > < / span >
< / button >
`);
< / script > < / div >
< div class = "sidebar-primary-item" > < nav class = "bd-links bd-docs-nav" aria-label = "Main" >
< div class = "bd-toc-item navbar-nav active" >
< ul class = "current nav bd-sidenav" >
< li class = "toctree-l1 current active" > < a class = "current reference internal" href = "#" > API Reference< / a > < / li >
< / ul >
< / div >
< / nav > < / div >
< / div >
< div class = "sidebar-primary-items__end sidebar-primary__section" >
< / div >
< div id = "rtd-footer-container" > < / div >
< / div >
< main id = "main-content" class = "bd-main" role = "main" >
< div class = "sbt-scroll-pixel-helper" > < / div >
< div class = "bd-content" >
< div class = "bd-article-container" >
< div class = "bd-header-article d-print-none" >
< div class = "header-article-items header-article__inner" >
< div class = "header-article-items__start" >
< div class = "header-article-item" > < button class = "sidebar-toggle primary-toggle btn btn-sm" title = "Toggle primary sidebar" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< span class = "fa-solid fa-bars" > < / span >
< / button > < / div >
< / div >
< div class = "header-article-items__end" >
< div class = "header-article-item" >
< div class = "article-header-buttons" >
< div class = "dropdown dropdown-source-buttons" >
< button class = "btn dropdown-toggle" type = "button" data-bs-toggle = "dropdown" aria-expanded = "false" aria-label = "Source repositories" >
< i class = "fab fa-github" > < / i >
< / button >
< ul class = "dropdown-menu" >
< li > < a href = "https://github.com/OleehyO/TexTeller" target = "_blank"
class="btn btn-sm btn-source-repository-button dropdown-item"
title="Source repository"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fab fa-github" > < / i >
< / span >
< span class = "btn__text-container" > Repository< / span >
< / a >
< / li >
< li > < a href = "https://github.com/OleehyO/TexTeller/edit/main/api.rst" target = "_blank"
class="btn btn-sm btn-source-edit-button dropdown-item"
title="Suggest edit"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-pencil-alt" > < / i >
< / span >
< span class = "btn__text-container" > Suggest edit< / span >
< / a >
< / li >
< li > < a href = "https://github.com/OleehyO/TexTeller/issues/new?title=Issue%20on%20page%20%2Fapi.html&body=Your%20issue%20content%20here." target = "_blank"
class="btn btn-sm btn-source-issues-button dropdown-item"
title="Open an issue"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-lightbulb" > < / i >
< / span >
< span class = "btn__text-container" > Open issue< / span >
< / a >
< / li >
< / ul >
< / div >
< div class = "dropdown dropdown-download-buttons" >
< button class = "btn dropdown-toggle" type = "button" data-bs-toggle = "dropdown" aria-expanded = "false" aria-label = "Download this page" >
< i class = "fas fa-download" > < / i >
< / button >
< ul class = "dropdown-menu" >
< li > < a href = "_sources/api.rst" target = "_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-file" > < / i >
< / span >
< span class = "btn__text-container" > .rst< / span >
< / a >
< / li >
< li >
< button onclick = "window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-file-pdf" > < / i >
< / span >
< span class = "btn__text-container" > .pdf< / span >
< / button >
< / li >
< / ul >
< / div >
< button onclick = "toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-expand" > < / i >
< / span >
< / button >
< script >
document.write(`
< button class = "btn btn-sm nav-link pst-navbar-icon theme-switch-button" title = "light/dark" aria-label = "light/dark" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< i class = "theme-switch fa-solid fa-sun fa-lg" data-mode = "light" > < / i >
< i class = "theme-switch fa-solid fa-moon fa-lg" data-mode = "dark" > < / i >
< i class = "theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode = "auto" > < / i >
< / button >
`);
< / script >
< script >
document.write(`
< button class = "btn btn-sm pst-navbar-icon search-button search-button__button" title = "Search" aria-label = "Search" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< i class = "fa-solid fa-magnifying-glass fa-lg" > < / i >
< / button >
`);
< / script >
< button class = "sidebar-toggle secondary-toggle btn btn-sm" title = "Toggle secondary sidebar" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< span class = "fa-solid fa-list" > < / span >
< / button >
< / div > < / div >
< / div >
< / div >
< / div >
< div id = "jb-print-docs-body" class = "onlyprint" >
< h1 > API Reference< / h1 >
<!-- Table of contents -->
< div id = "print-main-content" >
< div id = "jb-print-toc" >
< div >
< h2 > Contents < / h2 >
< / div >
< nav aria-label = "Page" >
< ul class = "visible nav section-nav flex-column" >
2025-04-21 08:50:57 +00:00
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#image-to-latex-conversion" > Image to LaTeX Conversion< / a > < / li >
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#paragraph-to-markdown-conversion" > Paragraph to Markdown Conversion< / a > < / li >
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#latex-detection" > LaTeX Detection< / a > < / li >
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#model-loading" > Model Loading< / a > < / li >
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#katex-conversion" > KaTeX Conversion< / a > < / li >
2025-04-21 05:05:53 +00:00
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div id = "searchbox" > < / div >
< article class = "bd-article" >
< section id = "api-reference" >
< h1 > API Reference< a class = "headerlink" href = "#api-reference" title = "Link to this heading" > #< / a > < / h1 >
< p > This section provides detailed API documentation for the TexTeller package. TexTeller is a tool for detecting and recognizing LaTeX formulas in images and converting mixed text and formula images to markdown.< / p >
< nav class = "contents local" id = "table-of-contents" >
< p class = "topic-title" > Table of Contents< / p >
< ul class = "simple" >
< li > < p > < a class = "reference internal" href = "#image-to-latex-conversion" id = "id1" > Image to LaTeX Conversion< / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "#paragraph-to-markdown-conversion" id = "id2" > Paragraph to Markdown Conversion< / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "#latex-detection" id = "id3" > LaTeX Detection< / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "#model-loading" id = "id4" > Model Loading< / a > < / p > < / li >
< li > < p > < a class = "reference internal" href = "#katex-conversion" id = "id5" > KaTeX Conversion< / a > < / p > < / li >
< / ul >
< / nav >
< section id = "image-to-latex-conversion" >
< h2 > < a class = "toc-backref" href = "#id1" role = "doc-backlink" > Image to LaTeX Conversion< / a > < a class = "headerlink" href = "#image-to-latex-conversion" title = "Link to this heading" > #< / a > < / h2 >
< / section >
< section id = "paragraph-to-markdown-conversion" >
< h2 > < a class = "toc-backref" href = "#id2" role = "doc-backlink" > Paragraph to Markdown Conversion< / a > < a class = "headerlink" href = "#paragraph-to-markdown-conversion" title = "Link to this heading" > #< / a > < / h2 >
< / section >
< section id = "latex-detection" >
< h2 > < a class = "toc-backref" href = "#id3" role = "doc-backlink" > LaTeX Detection< / a > < a class = "headerlink" href = "#latex-detection" title = "Link to this heading" > #< / a > < / h2 >
< / section >
< section id = "model-loading" >
< h2 > < a class = "toc-backref" href = "#id4" role = "doc-backlink" > Model Loading< / a > < a class = "headerlink" href = "#model-loading" title = "Link to this heading" > #< / a > < / h2 >
< / section >
< section id = "katex-conversion" >
< h2 > < a class = "toc-backref" href = "#id5" role = "doc-backlink" > KaTeX Conversion< / a > < a class = "headerlink" href = "#katex-conversion" title = "Link to this heading" > #< / a > < / h2 >
< / section >
< / section >
< / article >
< footer class = "prev-next-footer d-print-none" >
< div class = "prev-next-area" >
< a class = "left-prev"
href="index.html"
title="previous page">
< i class = "fa-solid fa-angle-left" > < / i >
< div class = "prev-next-info" >
< p class = "prev-next-subtitle" > previous< / p >
< p class = "prev-next-title" > TexTeller Documentation< / p >
< / div >
< / a >
< / div >
< / footer >
< / div >
< div class = "bd-sidebar-secondary bd-toc" > < div class = "sidebar-secondary-items sidebar-secondary__inner" >
< div class = "sidebar-secondary-item" >
< div class = "page-toc tocsection onthispage" >
< i class = "fa-solid fa-list" > < / i > Contents
< / div >
< nav class = "bd-toc-nav page-toc" >
< ul class = "visible nav section-nav flex-column" >
2025-04-21 08:50:57 +00:00
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#image-to-latex-conversion" > Image to LaTeX Conversion< / a > < / li >
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#paragraph-to-markdown-conversion" > Paragraph to Markdown Conversion< / a > < / li >
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#latex-detection" > LaTeX Detection< / a > < / li >
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#model-loading" > Model Loading< / a > < / li >
< li class = "toc-h2 nav-item toc-entry" > < a class = "reference internal nav-link" href = "#katex-conversion" > KaTeX Conversion< / a > < / li >
2025-04-21 05:05:53 +00:00
< / ul >
< / nav > < / div >
< / div > < / div >
< / div >
< footer class = "bd-footer-content" >
< div class = "bd-footer-content__inner container" >
< div class = "footer-item" >
< p class = "component-author" >
By TexTeller Team
< / p >
< / div >
< div class = "footer-item" >
< p class = "copyright" >
© Copyright 2025, TexTeller Team.
< br / >
< / p >
< / div >
< div class = "footer-item" >
< / div >
< div class = "footer-item" >
< / div >
< / div >
< / footer >
< / main >
< / div >
< / div >
<!-- Scripts loaded after <body> so the DOM is not blocked -->
< script src = "_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" > < / script >
< script src = "_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" > < / script >
< footer class = "bd-footer" >
< / footer >
< / body >
< / html >
