<h1>Pyladoc classes, functions and submodules<aclass="headerlink"href="#pyladoc-classes-functions-and-submodules"title="Link to this heading"></a></h1>
<sectionid="documentwriter-class">
<h2>DocumentWriter Class<aclass="headerlink"href="#documentwriter-class"title="Link to this heading"></a></h2>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.</span></span><spanclass="sig-name descname"><spanclass="pre">DocumentWriter</span></span><aclass="headerlink"href="#pyladoc.DocumentWriter"title="Link to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_diagram</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">fig</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">caption</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ref_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix_pattern</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Figure</span><spanclass="pre">{}:</span><spanclass="pre">'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ref_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'fig'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">centered</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.add_diagram"title="Link to this definition"></a></dt>
<li><p><strong>fig</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">None</span></code></span>) – The figure to add (matplotlib figure)</p></li>
<li><p><strong>caption</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The caption for the figure</p></li>
<li><p><strong>ref_id</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – If provided, the figure can be referenced by this string</p></li>
<li><p><strong>prefix_pattern</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></span>) – Whether to center the figure in LaTeX output</p></li>
<spanclass="sig-name descname"><spanclass="pre">add_document</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">doc</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.add_document"title="Link to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_equation</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">latex_equation</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ref_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ref_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'eq'</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.add_equation"title="Link to this definition"></a></dt>
<li><p><strong>ref_id</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – If provided, the equation is displayed with
a number and can be referenced by the ref_id</p></li>
<spanclass="sig-name descname"><spanclass="pre">add_h1</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.add_h1"title="Link to this definition"></a></dt>
<ddclass="field-odd"><p><strong>text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The text of the heading</p>
<spanclass="sig-name descname"><spanclass="pre">add_h2</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.add_h2"title="Link to this definition"></a></dt>
<ddclass="field-odd"><p><strong>text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The text of the heading</p>
<spanclass="sig-name descname"><spanclass="pre">add_h3</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.add_h3"title="Link to this definition"></a></dt>
<ddclass="field-odd"><p><strong>text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The text of the heading</p>
<spanclass="sig-name descname"><spanclass="pre">add_html</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em><spanclass="sig-paren">)</span><aclass="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
<ddclass="field-odd"><p><strong>text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The HTML to add to the document</p>
<spanclass="sig-name descname"><spanclass="pre">add_markdown</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">section_class</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.add_markdown"title="Link to this definition"></a></dt>
<dd><p>Adds a markdown formatted text to the document.</p>
<li><p><strong>text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The markdown text to add</p></li>
<li><p><strong>section_class</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The class for the text section</p></li>
<spanclass="sig-name descname"><spanclass="pre">add_table</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">table</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">caption</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ref_id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prefix_pattern</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'Table</span><spanclass="pre">{}:</span><spanclass="pre">'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ref_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'table'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">centered</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.add_table"title="Link to this definition"></a></dt>
<li><p><strong>table</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">None</span></code></span>) – The table to add (pandas DataFrame or Styler)</p></li>
<li><p><strong>caption</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The caption for the table</p></li>
<li><p><strong>ref_id</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – If provided, the table can be referenced by this string</p></li>
<li><p><strong>prefix_pattern</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></span>) – Whether to center the table in LaTeX output</p></li>
<spanclass="sig-name descname"><spanclass="pre">add_text</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">section_class</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.add_text"title="Link to this definition"></a></dt>
<li><p><strong>text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The text to add</p></li>
<li><p><strong>section_class</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The class for the paragraph</p></li>
<spanclass="sig-name descname"><spanclass="pre">new_field</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.DocumentWriter.new_field"title="Link to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">to_html</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">figure_format</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'svg'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">base64_svgs</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">False</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">figure_scale</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">1</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<li><p><strong>figure_format</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-data docutils literal notranslate"><spanclass="pre">Literal</span></code>[<codeclass="docutils literal notranslate"><spanclass="pre">'svg'</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">'png'</span></code>, <codeclass="docutils literal notranslate"><spanclass="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> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></span>) – Whether to encode svg images in base64</p></li>
<spanclass="sig-name descname"><spanclass="pre">to_latex</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">font_family</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">table_renderer</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'simple'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">figure_scale</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">1</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<li><p><strong>file_path</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The path to save the PDF file to</p></li>
<li><p><strong>font_family</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-data docutils literal notranslate"><spanclass="pre">Literal</span></code>[<codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">'serif'</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">'sans-serif'</span></code>]</span>) – Overwrites the front family for figures and the template</p></li>
<li><p><strong>latex_template_path</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – Path to a LaTeX template file. The
expression <!–CONTENT–> will be replaced by the generated content.
If no path is provided a default template is used.</p></li>
<li><p><strong>fields_dict</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>[<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>, <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>]</span>) – A dictionary with field names as keys and content as values
replacing the placeholders <!–KEY–> in the template.</p></li>
<li><p><strong>figure_scale</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">float</span></code></span>) – Scaling factor for the figure size</p></li>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.</span></span><spanclass="sig-name descname"><spanclass="pre">escape_html</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.escape_html"title="Link to this definition"></a></dt>
<dd><p>Escapes special HTML characters in a given string.</p>
<ddclass="field-odd"><p><strong>text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The text to escape</p>
<li><p><strong>fig</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">None</span></code></span>) – The figure to convert</p></li>
<li><p><strong>figure_format</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-data docutils literal notranslate"><spanclass="pre">Literal</span></code>[<codeclass="docutils literal notranslate"><spanclass="pre">'svg'</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">'png'</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">'pgf'</span></code>]</span>) – The format to save the figure in (svg, png or pgf)</p></li>
<li><p><strong>font_family</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> | <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">None</span></code></span>) – The font family to use for the figure</p></li>
<li><p><strong>scale</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">float</span></code></span>) – Scaling factor for the figure size</p></li>
<li><p><strong>alt_text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The alt text for the figure</p></li>
<li><p><strong>base64</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></span>) – If the format is svg this determine if the image is encode in base64</p></li>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.</span></span><spanclass="sig-name descname"><spanclass="pre">inject_to_template</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">fields_dict</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">template_path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">internal_template</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">template_string</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.inject_to_template"title="Link to this definition"></a></dt>
<dd><p>injects content fields into a template. The placeholder <!–CONTENT–>
<li><p><strong>fields_dict</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>[<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>, <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>]</span>) – A dictionary with field names as keys and content as values</p></li>
<li><p><strong>template_string</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – A template string to use directly</p></li>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.</span></span><spanclass="sig-name descname"><spanclass="pre">latex_to_figure</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">latex_code</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.latex_to_figure"title="Link to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.latex.</span></span><spanclass="sig-name descname"><spanclass="pre">basic_formatter</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.latex.basic_formatter"title="Link to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.latex.</span></span><spanclass="sig-name descname"><spanclass="pre">compile</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">latex_code</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">output_file</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">encoding</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'utf-8'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">engine</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'pdflatex'</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.latex.compile"title="Link to this definition"></a></dt>
<li><p><strong>encoding</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The encoding of the LaTeX code.</p></li>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.latex.</span></span><spanclass="sig-name descname"><spanclass="pre">escape_text</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<ddclass="field-odd"><p><strong>text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The text to escape</p>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.latex.</span></span><spanclass="sig-name descname"><spanclass="pre">from_html</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">html_code</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.latex.from_html"title="Link to this definition"></a></dt>
<dd><p>Converts HTML code to LaTeX code using HTMLParser.</p>
<ddclass="field-odd"><p><strong>html_code</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The HTML code to convert.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.latex.</span></span><spanclass="sig-name descname"><spanclass="pre">get_equation_code</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">equation</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">reference</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">block</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">False</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.latex.get_equation_code"title="Link to this definition"></a></dt>
<dd><p>Converts an equation string to LaTeX code.</p>
<li><p><strong>reference</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> | <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">None</span></code></span>) – The reference type and ID for the equation separated by a ‘:’.</p></li>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.latex.</span></span><spanclass="sig-name descname"><spanclass="pre">inject_latex_command</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">command</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyladoc.latex.inject_latex_command"title="Link to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.latex.</span></span><spanclass="sig-name descname"><spanclass="pre">normalize_label_text</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.latex.</span></span><spanclass="sig-name descname"><spanclass="pre">render_pandas_styler_table</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">df_style</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">caption</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">label</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">centering</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<li><p><strong>df_style</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">None</span></code></span>) – The pandas Styler object to convert.</p></li>
<li><p><strong>caption</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The caption for the table.</p></li>
<li><p><strong>label</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – Label for referencing the table.</p></li>
<li><p><strong>centering</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></span>) – Whether to center the table.</p></li>
<spanclass="sig-prename descclassname"><spanclass="pre">pyladoc.latex.</span></span><spanclass="sig-name descname"><spanclass="pre">to_ascii</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em><spanclass="sig-paren">)</span><aclass="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
<ddclass="field-odd"><p><strong>text</strong> (<spanclass="sphinx_autodoc_typehints-type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></span>) – The text to convert.</p>
