2025-05-26 08:14:43 +00:00
<!DOCTYPE html>
2025-06-06 17:22:10 +00:00
< html lang = "en" data-content_root = "./" >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title > Index — pyladoc documentation< / title >
< script data-cfasync = "false" >
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
< / script >
<!--
this give us a css class that will be invisible only if js is disabled
-->
< noscript >
< style >
.pst-js-only { display: none !important; }
< / style >
< / noscript >
<!-- Loaded before other Sphinx assets -->
< link href = "_static/styles/theme.css?digest=8878045cc6db502f8baf" rel = "stylesheet" / >
< link href = "_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel = "stylesheet" / >
< link rel = "stylesheet" type = "text/css" href = "_static/pygments.css?v=8f2a1f02" / >
<!-- So that users can add custom icons -->
< script src = "_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf" > < / script >
<!-- Pre - loaded scripts that we'll load fully later -->
< link rel = "preload" as = "script" href = "_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" / >
< link rel = "preload" as = "script" href = "_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" / >
< script src = "_static/documentation_options.js?v=5929fcd5" > < / script >
< script src = "_static/doctools.js?v=9bcbadda" > < / script >
< script src = "_static/sphinx_highlight.js?v=dc90522c" > < / script >
< script > DOCUMENTATION _OPTIONS . pagename = 'genindex' ; < / script >
2025-05-26 08:14:43 +00:00
< link rel = "index" title = "Index" href = "#" / >
2025-06-06 17:22:10 +00:00
< link rel = "search" title = "Search" href = "search.html" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< meta name = "docsearch:language" content = "en" / >
< meta name = "docsearch:version" content = "" / >
< / 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 >
2025-05-26 08:14:43 +00:00
2025-06-06 17:22:10 +00:00
< dialog id = "pst-search-dialog" >
< 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"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
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 >
< / dialog >
2025-05-26 08:14:43 +00:00
2025-06-06 17:22:10 +00:00
< 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 >
2025-05-26 08:14:43 +00:00
< / div >
2025-06-06 17:22:10 +00:00
< header class = "bd-header navbar navbar-expand-lg bd-navbar d-print-none" >
< div class = "bd-header__inner bd-page-width" >
< button class = "pst-navbar-icon sidebar-toggle primary-toggle" aria-label = "Site navigation" >
< span class = "fa-solid fa-bars" > < / span >
< / button >
< div class = "col-lg-3 navbar-header-items__start" >
< div class = "navbar-item" >
< a class = "navbar-brand logo" href = "index.html" >
< p class = "title logo__title" > pyladoc documentation< / p >
< / a > < / div >
< / div >
< div class = "col-lg-9 navbar-header-items" >
< div class = "me-auto navbar-header-items__center" >
< div class = "navbar-item" >
< nav >
< ul class = "bd-navbar-elements navbar-nav" >
< li class = "nav-item " >
< a class = "nav-link nav-internal" href = "_autogenerated/index.html" >
Classes and functions
< / a >
< / li >
2025-05-26 08:14:43 +00:00
< / ul >
2025-06-06 17:22:10 +00:00
< / nav > < / div >
< / div >
< div class = "navbar-header-items__end" >
< div class = "navbar-item navbar-persistent--container" >
< button class = "btn search-button-field search-button__button pst-js-only" 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 >
< / div >
< div class = "navbar-item" >
< button class = "btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label = "Color mode" data-bs-title = "Color mode" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< i class = "theme-switch fa-solid fa-sun fa-lg" data-mode = "light" title = "Light" > < / i >
< i class = "theme-switch fa-solid fa-moon fa-lg" data-mode = "dark" title = "Dark" > < / i >
< i class = "theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode = "auto" title = "System Settings" > < / i >
< / button > < / div >
< / div >
< / div >
< div class = "navbar-persistent--mobile" >
< button class = "btn search-button-field search-button__button pst-js-only" 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 >
< / div >
2025-05-26 08:14:43 +00:00
< / div >
2025-06-06 17:22:10 +00:00
< / header >
< div class = "bd-container" >
< div class = "bd-container__inner bd-page-width" >
< dialog id = "pst-primary-sidebar-modal" > < / dialog >
< div id = "pst-primary-sidebar" class = "bd-sidebar-primary bd-sidebar hide-on-wide" >
< div class = "sidebar-header-items sidebar-primary__section" >
< div class = "sidebar-header-items__center" >
< div class = "navbar-item" >
< nav >
< ul class = "bd-navbar-elements navbar-nav" >
< li class = "nav-item " >
< a class = "nav-link nav-internal" href = "_autogenerated/index.html" >
Classes and functions
< / a >
< / li >
< / ul >
< / nav > < / div >
< / div >
< div class = "sidebar-header-items__end" >
< div class = "navbar-item" >
< button class = "btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label = "Color mode" data-bs-title = "Color mode" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< i class = "theme-switch fa-solid fa-sun fa-lg" data-mode = "light" title = "Light" > < / i >
< i class = "theme-switch fa-solid fa-moon fa-lg" data-mode = "dark" title = "Dark" > < / i >
< i class = "theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode = "auto" title = "System Settings" > < / i >
< / button > < / div >
< / div >
< / div >
< div class = "sidebar-primary-items__end sidebar-primary__section" >
< div class = "sidebar-primary-item" >
< div id = "ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
< / div > < / div >
< / div >
< / div >
< main id = "main-content" class = "bd-main" role = "main" >
< div class = "bd-content" >
< div class = "bd-article-container" >
< div class = "bd-header-article d-print-none" > < / div >
< div id = "searchbox" > < / div >
< article class = "bd-article" >
2025-05-26 08:14:43 +00:00
< h1 id = "index" > Index< / h1 >
< div class = "genindex-jumpbox" >
< a href = "#A" > < strong > A< / strong > < / a >
| < a href = "#C" > < strong > C< / strong > < / a >
| < a href = "#D" > < strong > D< / strong > < / a >
| < a href = "#E" > < strong > E< / strong > < / a >
| < a href = "#F" > < strong > F< / strong > < / a >
| < a href = "#G" > < strong > G< / strong > < / a >
| < a href = "#I" > < strong > I< / strong > < / a >
| < a href = "#L" > < strong > L< / strong > < / a >
| < a href = "#N" > < strong > N< / strong > < / a >
| < a href = "#R" > < strong > R< / strong > < / a >
| < a href = "#T" > < strong > T< / strong > < / a >
< / div >
< h2 id = "A" > A< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_diagram" > add_diagram() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_document" > add_document() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_equation" > add_equation() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_h1" > add_h1() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_h2" > add_h2() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_h3" > add_h3() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_html" > add_html() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_markdown" > add_markdown() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_table" > add_table() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.add_text" > add_text() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "C" > C< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/compile.html#pyladoc.latex.compile" > compile() (in module pyladoc.latex)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "D" > D< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter" > DocumentWriter (class in pyladoc)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "E" > E< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/escape_html.html#pyladoc.escape_html" > escape_html() (in module pyladoc)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/escape_text.html#pyladoc.latex.escape_text" > escape_text() (in module pyladoc.latex)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "F" > F< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/figure_to_string.html#pyladoc.figure_to_string" > figure_to_string() (in module pyladoc)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/from_html.html#pyladoc.latex.from_html" > from_html() (in module pyladoc.latex)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "G" > G< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/get_equation_code.html#pyladoc.latex.get_equation_code" > get_equation_code() (in module pyladoc.latex)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "I" > I< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/inject_latex_command.html#pyladoc.latex.inject_latex_command" > inject_latex_command() (in module pyladoc.latex)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/inject_to_template.html#pyladoc.inject_to_template" > inject_to_template() (in module pyladoc)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "L" > L< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/latex_to_figure.html#pyladoc.latex_to_figure" > latex_to_figure() (in module pyladoc)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "N" > N< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.new_field" > new_field() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/normalize_label_text.html#pyladoc.latex.normalize_label_text" > normalize_label_text() (in module pyladoc.latex)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "R" > R< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/render_pandas_styler_table.html#pyladoc.latex.render_pandas_styler_table" > render_pandas_styler_table() (in module pyladoc.latex)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "T" > T< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/to_ascii.html#pyladoc.latex.to_ascii" > to_ascii() (in module pyladoc.latex)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.to_html" > to_html() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.to_latex" > to_latex() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
2025-06-06 17:22:10 +00:00
< li > < a href = "_autogenerated/DocumentWriter.html#pyladoc.DocumentWriter.to_pdf" > to_pdf() (pyladoc.DocumentWriter method)< / a >
2025-05-26 08:14:43 +00:00
< / li >
< / ul > < / td >
< / tr > < / table >
2025-06-06 17:22:10 +00:00
< / article >
< footer class = "prev-next-footer d-print-none" >
< div class = "prev-next-area" >
< / div >
< / footer >
< / div >
2025-05-26 08:14:43 +00:00
< / div >
2025-06-06 17:22:10 +00:00
< footer class = "bd-footer-content" >
< / footer >
< / main >
< / div >
2025-05-26 08:14:43 +00:00
< / div >
2025-06-06 17:22:10 +00:00
<!-- Scripts loaded after <body> so the DOM is not blocked -->
< script defer src = "_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" > < / script >
< script defer src = "_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" > < / script >
2025-05-26 08:14:43 +00:00
2025-06-06 17:22:10 +00:00
< footer class = "bd-footer" >
< div class = "bd-footer__inner bd-page-width" >
< div class = "footer-items__start" >
< div class = "footer-item" >
2025-05-26 08:14:43 +00:00
2025-06-06 17:22:10 +00:00
< p class = "copyright" >
© Copyright 2025, Nicolas Kruse.
< br / >
< / p >
< / div >
< div class = "footer-item" >
< p class = "sphinx-version" >
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 8.2.3.
< br / >
< / p >
< / div >
< / div >
< div class = "footer-items__end" >
< div class = "footer-item" >
< p class = "theme-version" >
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the < a href = "https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html" > PyData Sphinx Theme< / a > 0.16.1.
< / p > < / div >
< / div >
< / div >
2025-05-26 08:14:43 +00:00
2025-06-06 17:22:10 +00:00
< / footer >
< / body >
2025-05-26 08:14:43 +00:00
< / html >
