Deploying to gh-pages from @ Nonannet/pyladoc@a65bb1c8e5 🚀

modules.html

@@ -341,16 +341,21 @@ guessing for text and numbers; pandas: using the internal pandas LaTeX renderer)
 
 <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>
+<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 &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>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 &lt;!–KEY–&gt; 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>
@@ -413,15 +418,17 @@ figures a img-tag is included in the output.</p>
 
 <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;
+<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">fields_dict</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>, <em class="sig-param"><span class="n"><span class="pre">template_string</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 content fields 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>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</p></li>
 <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>
+<li><p><strong>template_string</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – A template string to use directly</p></li>
 </ul>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>