nicolas
/
pyladoc
mirror of https://github.com/Nonannet/pyladoc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pyladoc/modules.html

637 lines
59 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Pyladoc classes, functions and submodules &mdash; pyladoc documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<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 src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Pyladoc" href="readme.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
pyladoc
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="readme.html">Pyladoc</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Pyladoc classes, functions and submodules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#documentwriter-class">DocumentWriter Class</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.DocumentWriter"><code class="docutils literal notranslate"><span class="pre">DocumentWriter</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_diagram"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_diagram()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_document"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_document()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_equation"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_equation()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_h1"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_h1()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_h2"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_h2()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_h3"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_h3()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_html"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_html()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_markdown"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_markdown()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_table"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_table()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.add_text"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_text()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.new_field"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.new_field()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.to_html"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.to_html()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.to_latex"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.to_latex()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#pyladoc.DocumentWriter.to_pdf"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.to_pdf()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#functions">Functions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.escape_html"><code class="docutils literal notranslate"><span class="pre">escape_html()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.figure_to_string"><code class="docutils literal notranslate"><span class="pre">figure_to_string()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.inject_to_template"><code class="docutils literal notranslate"><span class="pre">inject_to_template()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex_to_figure"><code class="docutils literal notranslate"><span class="pre">latex_to_figure()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#submodule-latex">Submodule latex</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex.basic_formatter"><code class="docutils literal notranslate"><span class="pre">basic_formatter()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex.compile"><code class="docutils literal notranslate"><span class="pre">compile()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex.escape_text"><code class="docutils literal notranslate"><span class="pre">escape_text()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex.from_html"><code class="docutils literal notranslate"><span class="pre">from_html()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex.get_equation_code"><code class="docutils literal notranslate"><span class="pre">get_equation_code()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex.inject_latex_command"><code class="docutils literal notranslate"><span class="pre">inject_latex_command()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex.normalize_label_text"><code class="docutils literal notranslate"><span class="pre">normalize_label_text()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex.render_pandas_styler_table"><code class="docutils literal notranslate"><span class="pre">render_pandas_styler_table()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyladoc.latex.to_ascii"><code class="docutils literal notranslate"><span class="pre">to_ascii()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pyladoc</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Pyladoc classes, functions and submodules</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/modules.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="pyladoc-classes-functions-and-submodules">
<h1>Pyladoc classes, functions and submodules<a class="headerlink" href="#pyladoc-classes-functions-and-submodules" title="Link to this heading"></a></h1>
<section id="documentwriter-class">
<h2>DocumentWriter Class<a class="headerlink" href="#documentwriter-class" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyladoc.</span></span><span class="sig-name descname"><span class="pre">DocumentWriter</span></span><a class="headerlink" href="#pyladoc.DocumentWriter" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A class to create a document for exporting to HTML or LaTeX.</p>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_diagram">
<span class="sig-name descname"><span class="pre">add_diagram</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fig</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">caption</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix_pattern</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Figure</span> <span class="pre">{}:</span> <span class="pre">'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'fig'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">centered</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_diagram" title="Link to this definition"></a></dt>
<dd><p>Adds a diagram to the document.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>fig</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span>) – The figure to add (matplotlib figure)</p></li>
<li><p><strong>caption</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The caption for the figure</p></li>
<li><p><strong>ref_id</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – If provided, the figure can be referenced by this string</p></li>
<li><p><strong>prefix_pattern</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – A custom string for the caption prefix, {} will
be replaced by the figure number</p></li>
<li><p><strong>ref_type</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The type of reference. Each type (e.g., ‘fig’, ‘table’)
has an individual numbering</p></li>
<li><p><strong>centered</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – Whether to center the figure in LaTeX output</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_document">
<span class="sig-name descname"><span class="pre">add_document</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">doc</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_document" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_equation">
<span class="sig-name descname"><span class="pre">add_equation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">latex_equation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'eq'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_equation" title="Link to this definition"></a></dt>
<dd><p>Adds a LaTeX equation to the document.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>latex_equation</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – LaTeX formatted equation</p></li>
<li><p><strong>ref_id</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – If provided, the equation is displayed with
a number and can be referenced by the ref_id</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_h1">
<span class="sig-name descname"><span class="pre">add_h1</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_h1" title="Link to this definition"></a></dt>
<dd><p>Adds a h1 heading to the document.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The text of the heading</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_h2">
<span class="sig-name descname"><span class="pre">add_h2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_h2" title="Link to this definition"></a></dt>
<dd><p>Adds a h2 heading to the document.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The text of the heading</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_h3">
<span class="sig-name descname"><span class="pre">add_h3</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_h3" title="Link to this definition"></a></dt>
<dd><p>Adds a h3 heading to the document.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The text of the heading</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_html">
<span class="sig-name descname"><span class="pre">add_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_html" title="Link to this definition"></a></dt>
<dd><p>Adds HTML formatted text to the document. For the LaTeX
export only basic HTML for text formatting and tables
is supported.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The HTML to add to the document</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_markdown">
<span class="sig-name descname"><span class="pre">add_markdown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">section_class</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_markdown" title="Link to this definition"></a></dt>
<dd><p>Adds a markdown formatted text to the document.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The markdown text to add</p></li>
<li><p><strong>section_class</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The class for the text section</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_table">
<span class="sig-name descname"><span class="pre">add_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">caption</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix_pattern</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Table</span> <span class="pre">{}:</span> <span class="pre">'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'table'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">centered</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_table" title="Link to this definition"></a></dt>
<dd><p>Adds a table to the document.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>table</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span>) – The table to add (pandas DataFrame or Styler)</p></li>
<li><p><strong>caption</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The caption for the table</p></li>
<li><p><strong>ref_id</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – If provided, the table can be referenced by this string</p></li>
<li><p><strong>prefix_pattern</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – A custom string for the caption prefix, {} will
be replaced by the table number</p></li>
<li><p><strong>ref_type</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The type of reference. Each type (e.g., ‘fig’, ‘table’)
has an individual numbering</p></li>
<li><p><strong>centered</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – Whether to center the table in LaTeX output</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.add_text">
<span class="sig-name descname"><span class="pre">add_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">section_class</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.add_text" title="Link to this definition"></a></dt>
<dd><p>Adds a text paragraph to the document.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The text to add</p></li>
<li><p><strong>section_class</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The class for the paragraph</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.new_field">
<span class="sig-name descname"><span class="pre">new_field</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.new_field" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#pyladoc.DocumentWriter" title="pyladoc.DocumentWriter"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocumentWriter</span></code></a></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.to_html">
<span class="sig-name descname"><span class="pre">to_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">figure_format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'svg'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base64_svgs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">figure_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.to_html" title="Link to this definition"></a></dt>
<dd><p>Export the document to HTML. Figures will bew embedded in the HTML code.
The format can be selected between png in base64, inline svg or svg in base64.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>figure_format</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<code class="docutils literal notranslate"><span class="pre">'svg'</span></code>, <code class="docutils literal notranslate"><span class="pre">'png'</span></code>, <code class="docutils literal notranslate"><span class="pre">'pgf'</span></code>]</span>) – The format for embedding the figures in the HTML code (svg or png)</p></li>
<li><p><strong>base64_svgs</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – Whether to encode svg images in base64</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The HTML code</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.to_latex">
<span class="sig-name descname"><span class="pre">to_latex</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">font_family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_renderer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'simple'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">figure_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.to_latex" title="Link to this definition"></a></dt>
<dd><p>Export the document to LaTeX. Figures will be embedded as pgf graphics.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>font_family</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">'serif'</span></code>, <code class="docutils literal notranslate"><span class="pre">'sans-serif'</span></code>]</span>) – Overwrites the front family for figures</p></li>
<li><p><strong>table_renderer</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<code class="docutils literal notranslate"><span class="pre">'pandas'</span></code>, <code class="docutils literal notranslate"><span class="pre">'simple'</span></code>]</span>) – The renderer for tables (simple: renderer with column type
guessing for text and numbers; pandas: using the internal pandas LaTeX renderer)</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The LaTeX code</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pyladoc.DocumentWriter.to_pdf">
<span class="sig-name descname"><span class="pre">to_pdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_renderer</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'simple'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">latex_template_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">figure_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">engine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'pdflatex'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.DocumentWriter.to_pdf" title="Link to this definition"></a></dt>
<dd><p>Export the document to a PDF file using LaTeX.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file_path</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The path to save the PDF file to</p></li>
<li><p><strong>font_family</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">'serif'</span></code>, <code class="docutils literal notranslate"><span class="pre">'sans-serif'</span></code>]</span>) – Overwrites the front family for figures and the template</p></li>
<li><p><strong>latex_template_path</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Path to a LaTeX template file. The
expression &lt;!–CONTENT–&gt; will be replaced by the generated content.
If no path is provided a default template is used.</p></li>
<li><p><strong>engine</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<code class="docutils literal notranslate"><span class="pre">'pdflatex'</span></code>, <code class="docutils literal notranslate"><span class="pre">'lualatex'</span></code>, <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code>, <code class="docutils literal notranslate"><span class="pre">'tectonic'</span></code>]</span>) – LaTeX engine (pdflatex, lualatex, xelatex or tectonic)</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>True if the PDF file was successfully created</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.escape_html">
<span class="sig-prename descclassname"><span class="pre">pyladoc.</span></span><span class="sig-name descname"><span class="pre">escape_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.escape_html" title="Link to this definition"></a></dt>
<dd><p>Escapes special HTML characters in a given string.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The text to escape</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Escaped text save for inserting into HTML code</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.figure_to_string">
<span class="sig-prename descclassname"><span class="pre">pyladoc.</span></span><span class="sig-name descname"><span class="pre">figure_to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fig</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unique_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">figure_format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'svg'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">font_family</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alt_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base64</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.figure_to_string" title="Link to this definition"></a></dt>
<dd><p>Converts a matplotlib figure to a ascii-string. For png base64 encoding is
used in general, for svg base64 encoding can be enabled. For base64 encoded
figures a img-tag is included in the output.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>fig</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span>) – The figure to convert</p></li>
<li><p><strong>figure_format</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<code class="docutils literal notranslate"><span class="pre">'svg'</span></code>, <code class="docutils literal notranslate"><span class="pre">'png'</span></code>, <code class="docutils literal notranslate"><span class="pre">'pgf'</span></code>]</span>) – The format to save the figure in (svg, png or pgf)</p></li>
<li><p><strong>font_family</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span>) – The font family to use for the figure</p></li>
<li><p><strong>scale</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – Scaling factor for the figure size</p></li>
<li><p><strong>alt_text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The alt text for the figure</p></li>
<li><p><strong>base64</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – If the format is svg this determine if the image is encode in base64</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The figure as ascii-string</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.inject_to_template">
<span class="sig-prename descclassname"><span class="pre">pyladoc.</span></span><span class="sig-name descname"><span class="pre">inject_to_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">internal_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.inject_to_template" title="Link to this definition"></a></dt>
<dd><p>injects a content string into a template. The placeholder &lt;!–CONTENT–&gt;
will be replaced by the content. If the placeholder is prefixed with a
‘%’ comment character, this character will be replaced as well.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_path</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Path to a template file</p></li>
<li><p><strong>internal_template</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Path to a internal default template</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Template with included content</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex_to_figure">
<span class="sig-prename descclassname"><span class="pre">pyladoc.</span></span><span class="sig-name descname"><span class="pre">latex_to_figure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">latex_code</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex_to_figure" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
</dd>
</dl>
</dd></dl>
</section>
<section id="submodule-latex">
<h2>Submodule latex<a class="headerlink" href="#submodule-latex" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex.basic_formatter">
<span class="sig-prename descclassname"><span class="pre">pyladoc.latex.</span></span><span class="sig-name descname"><span class="pre">basic_formatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex.basic_formatter" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex.compile">
<span class="sig-prename descclassname"><span class="pre">pyladoc.latex.</span></span><span class="sig-name descname"><span class="pre">compile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">latex_code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf-8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">engine</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'pdflatex'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex.compile" title="Link to this definition"></a></dt>
<dd><p>Compiles LaTeX code to a PDF file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>latex_code</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The LaTeX code to compile.</p></li>
<li><p><strong>output_file</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The output file path.</p></li>
<li><p><strong>encoding</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The encoding of the LaTeX code.</p></li>
<li><p><strong>engine</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Literal</span></code>[<code class="docutils literal notranslate"><span class="pre">'pdflatex'</span></code>, <code class="docutils literal notranslate"><span class="pre">'lualatex'</span></code>, <code class="docutils literal notranslate"><span class="pre">'xelatex'</span></code>, <code class="docutils literal notranslate"><span class="pre">'tectonic'</span></code>]</span>) – LaTeX engine (pdflatex, lualatex, xelatex or tectonic)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p>A boolean indicating whether the compilation was successful.</p></li>
<li><p>A list of errors.</p></li>
<li><p>A list of warnings.</p></li>
</ul>
</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>A tuple with three elements</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex.escape_text">
<span class="sig-prename descclassname"><span class="pre">pyladoc.latex.</span></span><span class="sig-name descname"><span class="pre">escape_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex.escape_text" title="Link to this definition"></a></dt>
<dd><p>Escapes special LaTeX characters and often used unicode characters in a given string.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The text to escape</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Escaped text</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex.from_html">
<span class="sig-prename descclassname"><span class="pre">pyladoc.latex.</span></span><span class="sig-name descname"><span class="pre">from_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">html_code</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex.from_html" title="Link to this definition"></a></dt>
<dd><p>Converts HTML code to LaTeX code using HTMLParser.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>html_code</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The HTML code to convert.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The LaTeX code.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex.get_equation_code">
<span class="sig-prename descclassname"><span class="pre">pyladoc.latex.</span></span><span class="sig-name descname"><span class="pre">get_equation_code</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">equation</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reference</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex.get_equation_code" title="Link to this definition"></a></dt>
<dd><p>Converts an equation string to LaTeX code.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>equation</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The LaTeX equation string.</p></li>
<li><p><strong>reference</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span>) – The reference type and ID for the equation separated by a ‘:’.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex.inject_latex_command">
<span class="sig-prename descclassname"><span class="pre">pyladoc.latex.</span></span><span class="sig-name descname"><span class="pre">inject_latex_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex.inject_latex_command" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex.normalize_label_text">
<span class="sig-prename descclassname"><span class="pre">pyladoc.latex.</span></span><span class="sig-name descname"><span class="pre">normalize_label_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex.normalize_label_text" title="Link to this definition"></a></dt>
<dd><p>Replace any special non-allowed character in the lable text.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Input text</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Normalized text</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex.render_pandas_styler_table">
<span class="sig-prename descclassname"><span class="pre">pyladoc.latex.</span></span><span class="sig-name descname"><span class="pre">render_pandas_styler_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">df_style</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">caption</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">centering</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex.render_pandas_styler_table" title="Link to this definition"></a></dt>
<dd><p>Converts a pandas Styler object to LaTeX table.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>df_style</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span>) – The pandas Styler object to convert.</p></li>
<li><p><strong>caption</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The caption for the table.</p></li>
<li><p><strong>label</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – Label for referencing the table.</p></li>
<li><p><strong>centering</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – Whether to center the table.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The LaTeX code.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pyladoc.latex.to_ascii">
<span class="sig-prename descclassname"><span class="pre">pyladoc.latex.</span></span><span class="sig-name descname"><span class="pre">to_ascii</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyladoc.latex.to_ascii" title="Link to this definition"></a></dt>
<dd><p>Replaces/escapes often used unicode characters in LaTeX code or text
with its LaTeX ascii equivalents.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – The text to convert.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The escaped text.</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="readme.html" class="btn btn-neutral float-left" title="Pyladoc" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Nicolas Kruse.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink