mirror of https://github.com/Nonannet/pyladoc.git
712 lines
45 KiB
HTML
712 lines
45 KiB
HTML
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<html lang="en" data-content_root="../" >
|
|||
|
|
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|||
|
|
|
|||
|
|
<title>pyladoc.DocumentWriter — 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 = '_autogenerated/DocumentWriter';</script>
|
|||
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="../search.html" />
|
|||
|
|
<link rel="next" title="pyladoc.escape_html" href="escape_html.html" />
|
|||
|
|
<link rel="prev" title="Classes and functions" href="index.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>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<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>
|
|||
|
|
|
|||
|
|
<div class="pst-async-banner-revealer d-none">
|
|||
|
|
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
|
|||
|
|
<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 current active">
|
|||
|
|
<a class="nav-link nav-internal" href="index.html">
|
|||
|
|
Classes and functions
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</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>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
|
|||
|
|
<span class="fa-solid fa-outdent"></span>
|
|||
|
|
</button>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</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">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<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 current active">
|
|||
|
|
<a class="nav-link nav-internal" href="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__start sidebar-primary__section">
|
|||
|
|
<div class="sidebar-primary-item">
|
|||
|
|
<nav class="bd-docs-nav bd-links"
|
|||
|
|
aria-label="Section Navigation">
|
|||
|
|
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
|
|||
|
|
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">DocumentWriter Class:</span></p>
|
|||
|
|
<ul class="current nav bd-sidenav">
|
|||
|
|
<li class="toctree-l1 current active"><a class="current reference internal" href="#">pyladoc.DocumentWriter</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Functions:</span></p>
|
|||
|
|
<ul class="nav bd-sidenav">
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="escape_html.html">pyladoc.escape_html</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="figure_to_string.html">pyladoc.figure_to_string</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="inject_to_template.html">pyladoc.inject_to_template</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="latex_to_figure.html">pyladoc.latex_to_figure</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Submodule latex:</span></p>
|
|||
|
|
<ul class="nav bd-sidenav">
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="compile.html">pyladoc.latex.compile</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="escape_text.html">pyladoc.latex.escape_text</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="from_html.html">pyladoc.latex.from_html</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="get_equation_code.html">pyladoc.latex.get_equation_code</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="inject_latex_command.html">pyladoc.latex.inject_latex_command</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="normalize_label_text.html">pyladoc.latex.normalize_label_text</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="render_pandas_styler_table.html">pyladoc.latex.render_pandas_styler_table</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="to_ascii.html">pyladoc.latex.to_ascii</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</nav></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 class="header-article-items header-article__inner">
|
|||
|
|
|
|||
|
|
<div class="header-article-items__start">
|
|||
|
|
|
|||
|
|
<div class="header-article-item">
|
|||
|
|
|
|||
|
|
<nav aria-label="Breadcrumb" class="d-print-none">
|
|||
|
|
<ul class="bd-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li class="breadcrumb-item breadcrumb-home">
|
|||
|
|
<a href="../index.html" class="nav-link" aria-label="Home">
|
|||
|
|
<i class="fa-solid fa-home"></i>
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="breadcrumb-item"><a href="index.html" class="nav-link">Classes and functions</a></li>
|
|||
|
|
|
|||
|
|
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">pyladoc.DocumentWriter</span></li>
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div id="searchbox"></div>
|
|||
|
|
<article class="bd-article">
|
|||
|
|
|
|||
|
|
<section id="pyladoc-documentwriter">
|
|||
|
|
<h1>pyladoc.DocumentWriter<a class="headerlink" href="#pyladoc-documentwriter" title="Link to this heading">#</a></h1>
|
|||
|
|
<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>
|
|||
|
|
<p>Initializes the DocumentWriter instance.</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">fields_dict</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>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>
|
|||
|
|
<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 <!–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> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="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> (<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>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>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</article>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<footer class="prev-next-footer d-print-none">
|
|||
|
|
|
|||
|
|
<div class="prev-next-area">
|
|||
|
|
<a class="left-prev"
|
|||
|
|
href="index.html"
|
|||
|
|
title="previous page">
|
|||
|
|
<i class="fa-solid fa-angle-left"></i>
|
|||
|
|
<div class="prev-next-info">
|
|||
|
|
<p class="prev-next-subtitle">previous</p>
|
|||
|
|
<p class="prev-next-title">Classes and functions</p>
|
|||
|
|
</div>
|
|||
|
|
</a>
|
|||
|
|
<a class="right-next"
|
|||
|
|
href="escape_html.html"
|
|||
|
|
title="next page">
|
|||
|
|
<div class="prev-next-info">
|
|||
|
|
<p class="prev-next-subtitle">next</p>
|
|||
|
|
<p class="prev-next-title">pyladoc.escape_html</p>
|
|||
|
|
</div>
|
|||
|
|
<i class="fa-solid fa-angle-right"></i>
|
|||
|
|
</a>
|
|||
|
|
</div>
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<dialog id="pst-secondary-sidebar-modal"></dialog>
|
|||
|
|
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="sidebar-secondary-item">
|
|||
|
|
<div
|
|||
|
|
id="pst-page-navigation-heading-2"
|
|||
|
|
class="page-toc tocsection onthispage">
|
|||
|
|
<i class="fa-solid fa-list"></i> On this page
|
|||
|
|
</div>
|
|||
|
|
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
|
|||
|
|
<ul class="visible nav section-nav flex-column">
|
|||
|
|
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter"><code class="docutils literal notranslate"><span class="pre">DocumentWriter</span></code></a><ul class="nav section-nav flex-column">
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_diagram"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_diagram()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_document"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_document()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_equation"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_equation()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_h1"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_h1()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_h2"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_h2()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_h3"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_h3()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_html"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_html()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_markdown"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_markdown()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_table"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_table()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.add_text"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.add_text()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.new_field"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.new_field()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.to_html"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.to_html()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.to_latex"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.to_latex()</span></code></a></li>
|
|||
|
|
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyladoc.DocumentWriter.to_pdf"><code class="docutils literal notranslate"><span class="pre">DocumentWriter.to_pdf()</span></code></a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</nav></div>
|
|||
|
|
|
|||
|
|
<div class="sidebar-secondary-item">
|
|||
|
|
<div role="note" aria-label="source link">
|
|||
|
|
<h3>This Page</h3>
|
|||
|
|
<ul class="this-page-menu">
|
|||
|
|
<li><a href="../_sources/_autogenerated/DocumentWriter.md.txt"
|
|||
|
|
rel="nofollow">Show Source</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></div>
|
|||
|
|
|
|||
|
|
</div></div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer class="bd-footer-content">
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</main>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<!-- 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>
|
|||
|
|
|
|||
|
|
<footer class="bd-footer">
|
|||
|
|
<div class="bd-footer__inner bd-page-width">
|
|||
|
|
|
|||
|
|
<div class="footer-items__start">
|
|||
|
|
|
|||
|
|
<div class="footer-item">
|
|||
|
|
|
|||
|
|
<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>
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
</body>
|
|||
|
|
</html>
|