From 4555b713b9b699f417b15cdd2d03392a406d9303 Mon Sep 17 00:00:00 2001 From: Nonannet Date: Wed, 25 Jun 2025 06:41:29 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20Nonannet?= =?UTF-8?q?/pyladoc@5f6147c2b9422f4057c9fdbd0dbd4325754ee5ad=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.html | 46 +++++++++++++++++++++++++--------------------- searchindex.js | 2 +- 2 files changed, 26 insertions(+), 22 deletions(-) diff --git a/index.html b/index.html index 6469055..41ccca7 100644 --- a/index.html +++ b/index.html @@ -266,20 +266,20 @@

Pyladoc#

Description#

-

Pyladoc is a python package for programmatically generating HTML and -PDF/LaTeX output. This package targets specifically applications where reports -or results with Pandas-tables and Matplotlib-figures are generated -to be displayed as website and as PDF document without involving any manual +

Pyladoc is a Python package for programmatically generating HTML and +PDF/LaTeX output. This package specifically targets applications where reports +or results with Pandas tables and Matplotlib figures are generated +to be displayed as a website and as a PDF document without involving any manual formatting steps.

This package focuses on the “Document in Code” approach for cases where a lot of calculations and data handling is done but not a lot of document text needs to be displayed. The multiline string capability of Python -handles this very well. In comparison to “Code in Document”-templates -python tools supports this approach out of the box - similar doch docstrings.

-

As backend for PDF generation LaTeX is used. There are excellent engines for -rendering HTML to PDF, but even if there is no requirement for an -accurate typesetting and what not, placing programmatically content of variable -composition and element sizes on fixed size pages without manual intervention +handles this very well. In comparison to “Code in Document” templates, +Python tools support this approach out of the box—similar to docstrings.

+

LaTeX is used as the backend for PDF generation. There are excellent engines for +rendering HTML to PDF, but even if there is no requirement for +accurate typesetting, placing programmatically generated content of variable +composition and element sizes on fixed-size pages without manual intervention is a hard problem where LaTeX is superior.

@@ -298,7 +298,7 @@ is a hard problem where LaTeX is superior.

  • Tables (Pandas, Markdown or HTML)

  • Matplotlib figures

  • LaTeX equations (block or inline)

    • -

  • Named references for figures, tables and equations

    • +

  • Named references for figures, tables, and equations

    • @@ -306,7 +306,7 @@ is a hard problem where LaTeX is superior.

    @@ -314,7 +314,7 @@ is a hard problem where LaTeX is superior.

    Usage Scenarios#

      -

    • Webservices

      • +

    • Web services

    • Report generation for lab equipment

    @@ -325,18 +325,22 @@ is a hard problem where LaTeX is superior.

    pip install pyladoc
    +

    As well as with conda:

    +
    conda install conda-forge::pyladoc
+
    +

    Dependencies#

    Pyladoc depends on the markdown package.

    Optional dependencies are:

    -

    For the included template the miktex-LaTeX distribution works on Windows +

    For the included template, the miktex LaTeX distribution works on Windows and the following LaTeX setup works on Ubuntu (both tested in CI):

    sudo apt-get update
 sudo apt-get install -y texlive-latex-extra texlive-fonts-recommended lmodern texlive-xetex texlive-science
@@ -345,7 +349,7 @@ sudo apt-get install
 
    Usage#
    
-
    It is easy to use as the following example code shows:
    
+
    It is easy to use, as the following example code shows:
    
 
    import pyladoc
 import pandas as pd
 
@@ -381,7 +385,7 @@ sudo apt-get install
 
    Contributing#
    
-
    Contributions are welcome, please open an issue or submit a pull request on GitHub.
    
+
    Contributions are welcome; please open an issue or submit a pull request on GitHub.

    Developer Guide#

    @@ -391,12 +395,12 @@ sudo apt-get installcd pyladoc -

    It’s recommended to setup an venv:

    +

    It’s recommended to set up a venv:

    python -m venv .venv
 source .venv/bin/activate  # On Windows use `.venv\Scripts\activate`
    -

    Install the package and dev-dependencies while keeping files in the +

    Install the package and development dependencies while keeping files in the current directory:

    pip install -e .[dev]
    diff --git a/searchindex.js b/searchindex.js index c740c70..4159ac6 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles":{"Classes and functions":[[8,null]],"Contributing":[[15,"contributing"]],"Dependencies":[[15,"dependencies"]],"Description":[[15,"description"]],"Developer Guide":[[15,"developer-guide"]],"DocumentWriter Class:":[[8,null]],"Example outputs":[[15,"example-outputs"]],"Functions:":[[8,null]],"Installation":[[15,"installation"]],"Key Features":[[15,"key-features"]],"License":[[15,"license"]],"Pyladoc":[[15,null]],"Submodule latex:":[[8,null]],"Supported primitives":[[15,"supported-primitives"]],"Usage":[[15,"usage"]],"Usage Scenarios":[[15,"usage-scenarios"]],"pyladoc.DocumentWriter":[[1,null]],"pyladoc.escape_html":[[3,null]],"pyladoc.figure_to_string":[[5,null]],"pyladoc.inject_to_template":[[10,null]],"pyladoc.latex.compile":[[2,null]],"pyladoc.latex.escape_text":[[4,null]],"pyladoc.latex.from_html":[[6,null]],"pyladoc.latex.get_equation_code":[[7,null]],"pyladoc.latex.inject_latex_command":[[9,null]],"pyladoc.latex.normalize_label_text":[[12,null]],"pyladoc.latex.render_pandas_styler_table":[[13,null]],"pyladoc.latex.to_ascii":[[14,null]],"pyladoc.latex_to_figure":[[11,null]]},"docnames":["LICENSE","_autogenerated/DocumentWriter","_autogenerated/compile","_autogenerated/escape_html","_autogenerated/escape_text","_autogenerated/figure_to_string","_autogenerated/from_html","_autogenerated/get_equation_code","_autogenerated/index","_autogenerated/inject_latex_command","_autogenerated/inject_to_template","_autogenerated/latex_to_figure","_autogenerated/normalize_label_text","_autogenerated/render_pandas_styler_table","_autogenerated/to_ascii","index"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["LICENSE.md","_autogenerated/DocumentWriter.md","_autogenerated/compile.md","_autogenerated/escape_html.md","_autogenerated/escape_text.md","_autogenerated/figure_to_string.md","_autogenerated/from_html.md","_autogenerated/get_equation_code.md","_autogenerated/index.md","_autogenerated/inject_latex_command.md","_autogenerated/inject_to_template.md","_autogenerated/latex_to_figure.md","_autogenerated/normalize_label_text.md","_autogenerated/render_pandas_styler_table.md","_autogenerated/to_ascii.md","index.md"],"indexentries":{"add_diagram() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_diagram",false]],"add_document() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_document",false]],"add_equation() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_equation",false]],"add_h1() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_h1",false]],"add_h2() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_h2",false]],"add_h3() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_h3",false]],"add_html() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_html",false]],"add_markdown() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_markdown",false]],"add_table() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_table",false]],"add_text() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_text",false]],"compile() (in module pyladoc.latex)":[[2,"pyladoc.latex.compile",false]],"documentwriter (class in pyladoc)":[[1,"pyladoc.DocumentWriter",false]],"escape_html() (in module pyladoc)":[[3,"pyladoc.escape_html",false]],"escape_text() (in module pyladoc.latex)":[[4,"pyladoc.latex.escape_text",false]],"figure_to_string() (in module pyladoc)":[[5,"pyladoc.figure_to_string",false]],"from_html() (in module pyladoc.latex)":[[6,"pyladoc.latex.from_html",false]],"get_equation_code() (in module pyladoc.latex)":[[7,"pyladoc.latex.get_equation_code",false]],"inject_latex_command() (in module pyladoc.latex)":[[9,"pyladoc.latex.inject_latex_command",false]],"inject_to_template() (in module pyladoc)":[[10,"pyladoc.inject_to_template",false]],"latex_to_figure() (in module pyladoc)":[[11,"pyladoc.latex_to_figure",false]],"new_field() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.new_field",false]],"normalize_label_text() (in module pyladoc.latex)":[[12,"pyladoc.latex.normalize_label_text",false]],"render_pandas_styler_table() (in module pyladoc.latex)":[[13,"pyladoc.latex.render_pandas_styler_table",false]],"to_ascii() (in module pyladoc.latex)":[[14,"pyladoc.latex.to_ascii",false]],"to_html() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.to_html",false]],"to_latex() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.to_latex",false]],"to_pdf() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.to_pdf",false]]},"objects":{"pyladoc":[[1,0,1,"","DocumentWriter"],[3,2,1,"","escape_html"],[5,2,1,"","figure_to_string"],[10,2,1,"","inject_to_template"],[11,2,1,"","latex_to_figure"]],"pyladoc.DocumentWriter":[[1,1,1,"","add_diagram"],[1,1,1,"","add_document"],[1,1,1,"","add_equation"],[1,1,1,"","add_h1"],[1,1,1,"","add_h2"],[1,1,1,"","add_h3"],[1,1,1,"","add_html"],[1,1,1,"","add_markdown"],[1,1,1,"","add_table"],[1,1,1,"","add_text"],[1,1,1,"","new_field"],[1,1,1,"","to_html"],[1,1,1,"","to_latex"],[1,1,1,"","to_pdf"]],"pyladoc.latex":[[2,2,1,"","compile"],[4,2,1,"","escape_text"],[6,2,1,"","from_html"],[7,2,1,"","get_equation_code"],[9,2,1,"","inject_latex_command"],[12,2,1,"","normalize_label_text"],[13,2,1,"","render_pandas_styler_table"],[14,2,1,"","to_ascii"]]},"objnames":{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","function","Python function"]},"objtypes":{"0":"py:class","1":"py:method","2":"py:function"},"terms":{"":15,"1":[1,5,15],"100":15,"110":15,"12":15,"120":15,"150":15,"2025":0,"8":2,"A":[0,1,2,10],"AND":0,"AS":0,"As":15,"BE":0,"BUT":0,"FOR":0,"For":[1,5,15],"IN":0,"If":[1,5,10],"In":15,"It":15,"NO":0,"NOT":0,"OF":0,"OR":0,"On":15,"THE":0,"TO":0,"The":[0,1,2,3,4,5,6,7,10,13,14,15],"There":15,"To":15,"WITH":0,"abov":0,"accur":15,"action":0,"activ":15,"add":1,"add_diagram":1,"add_docu":1,"add_equ":1,"add_h1":1,"add_h2":1,"add_h3":1,"add_html":1,"add_markdown":[1,15],"add_tabl":[1,15],"add_text":1,"all":0,"allow":12,"alt":5,"alt_text":5,"an":[0,1,7,15],"ani":[0,12,15],"applic":15,"approach":15,"apt":15,"ar":15,"aris":0,"ascii":[5,14],"associ":0,"author":0,"backend":15,"base":1,"base64":[1,5,15],"base64_svg":1,"basic":1,"between":1,"bew":1,"bin":15,"block":[7,15],"bool":[1,5,13],"boolean":2,"both":15,"box":15,"c":0,"calcul":15,"can":[1,5,15],"capabl":15,"caption":[1,13],"case":15,"cd":15,"center":[1,13],"charact":[3,4,10,12,14],"charg":0,"ci":15,"claim":0,"class":1,"clone":15,"code":[1,2,3,6,7,9,13,14,15],"column":1,"com":15,"command":9,"comment":10,"comparison":15,"compil":8,"composit":15,"condit":0,"connect":0,"content":[1,10,15],"contract":0,"convert":[5,6,7,13,14],"copi":0,"copyright":0,"correctli":15,"creat":1,"current":15,"custom":1,"damag":0,"data":15,"datafram":[1,15],"deal":0,"default":[1,10],"detail":15,"determin":5,"dev":15,"df":15,"df_style":13,"diagram":1,"dict":[1,10],"dictionari":[1,10],"directli":10,"directori":15,"displai":[1,15],"distribut":[0,15],"do":0,"doc":[1,15],"doch":15,"docstr":15,"document":[0,1,15],"documentwrit":15,"done":15,"e":[1,15],"each":1,"easi":15,"element":[2,15],"embed":[1,15],"enabl":5,"encod":[1,2,5],"engin":[1,2,15],"ensur":15,"eq":[1,15],"equat":[1,7,15],"equip":15,"equival":14,"error":2,"escap":[3,4,14],"escape_html":8,"escape_text":8,"even":15,"event":0,"everyth":15,"excel":15,"export":[1,15],"express":[0,1],"extra":15,"factor":[1,5],"fals":[1,5,7],"famili":[1,5],"field":[1,10],"fields_dict":[1,10],"fig":[1,5],"figur":[1,5,15],"figure_format":[1,5],"figure_scal":1,"figure_to_str":8,"file":[0,1,2,10,15],"file_path":1,"first":15,"fit":0,"fix":15,"float":[1,5],"focus":15,"follow":[0,15],"font":[5,15],"font_famili":[1,5],"format":[1,5,15],"frac":15,"free":0,"from":0,"from_html":8,"front":1,"furnish":0,"g":[1,15],"gener":[1,5,15],"get":15,"get_equation_cod":8,"git":15,"github":15,"given":[3,4],"grant":0,"graphic":1,"guess":1,"h1":1,"h2":1,"h3":1,"ha":1,"handl":15,"hard":15,"head":[1,15],"herebi":0,"holder":0,"html":[1,3,6,15],"html_code":[6,15],"htmlparser":6,"http":15,"i":[0,1,5,10,15],"id":7,"ij":15,"imag":[1,5],"img":5,"impli":0,"import":15,"includ":[0,5,10,15],"indic":2,"individu":1,"initi":1,"inject":[9,10],"inject_latex_command":8,"inject_to_templ":8,"inlin":[1,15],"input":[9,12],"insert":3,"instanc":1,"intern":[1,10],"internal_templ":10,"intervent":15,"involv":15,"issu":15,"its":14,"j":15,"jinja2":15,"keep":15,"kei":[1,10],"kind":0,"km":15,"kruse":0,"lab":15,"label":[13,15],"labl":12,"lambda":15,"lambda_":15,"lambda_i":15,"last":9,"latex":[1,15],"latex_cod":[2,11],"latex_equ":1,"latex_template_path":1,"latex_to_figur":8,"liabil":0,"liabl":0,"licens":0,"limit":0,"line":9,"line1":15,"line2":15,"line3":15,"linux":15,"list":2,"liter":[1,2,5],"lmodern":15,"local":15,"lot":15,"lualatex":[1,2],"m":15,"machin":15,"manual":15,"markdown":[1,15],"matplotlib":[1,5,15],"merchant":0,"merg":0,"miktex":15,"mit":[0,15],"mix":15,"modifi":0,"multilin":15,"n":15,"name":[1,10,15],"need":15,"new_field":1,"nicola":0,"non":12,"nonannet":15,"none":[1,5,7,11,13],"noninfring":0,"normal":12,"normalize_label_text":8,"notic":0,"number":[1,15],"object":[1,13],"obtain":0,"obvious":15,"often":[4,14],"onli":1,"open":15,"option":15,"other":0,"otherwis":0,"out":[0,15],"output":[1,2,5],"output_fil":2,"overwrit":1,"packag":15,"page":15,"panda":[1,13,15],"pandas_exampl":15,"paragraph":1,"paramet":[1,2,3,4,5,6,7,9,10,12,13,14],"particular":0,"path":[1,2,10],"pd":15,"pdf":[1,2,15],"pdflatex":[1,2],"permiss":0,"permit":0,"person":0,"pgf":[1,5,15],"phi_":15,"pip":15,"place":15,"placehold":[1,10],"pleas":15,"png":[1,5,15],"portion":0,"prefix":[1,10],"prefix_pattern":1,"print":15,"problem":15,"programmat":15,"project":15,"provid":[0,1,9],"publish":0,"pull":15,"purpos":0,"py":15,"pyladoc":8,"pytest":15,"python":15,"random":15,"recommend":15,"ref_id":1,"ref_typ":1,"refer":[1,7,15],"referenc":[1,13],"render":[1,15],"render_pandas_styler_t":8,"replac":[1,10,12,14],"report":15,"repositori":15,"request":15,"requir":15,"restrict":0,"result":15,"return":[1,2,3,4,5,6,7,9,10,11,12,13,14],"right":0,"row1":15,"row2":15,"row3":15,"run":15,"same":15,"san":1,"save":[1,3,5],"scale":[1,5],"scienc":15,"script":15,"section":1,"section_class":1,"see":15,"select":1,"sell":0,"separ":7,"serif":1,"set":15,"setup":15,"shall":0,"show":15,"similar":15,"simpl":1,"singl":15,"size":[1,5,15],"so":0,"softwar":0,"some":15,"some_data":15,"sourc":15,"special":[3,4,12],"specif":15,"start":[9,15],"step":15,"str":[1,2,3,4,5,6,7,9,10,12,13,14],"string":[1,3,4,5,7,10,15],"styler":[1,13],"subject":0,"sublicens":0,"submit":15,"substanti":0,"success":2,"successfulli":1,"sudo":15,"sum_":15,"superior":15,"support":1,"svg":[1,5,15],"tabl":[1,13,15],"table_render":1,"tag":5,"target":15,"tecton":[1,2],"templat":[1,10,15],"template_path":10,"template_str":10,"test":15,"test1":15,"test_html_render1":15,"test_latex_render1":15,"test_rendering_example1_doc":15,"texliv":15,"text":[1,3,4,5,9,12,14,15],"thi":[0,1,5,10,15],"three":2,"tikz":15,"to_ascii":8,"to_html":[1,15],"to_latex":1,"to_pdf":[1,15],"tool":15,"tort":0,"true":[1,13],"tupl":2,"type":[1,2,3,4,5,6,7,9,10,11,12,13,14],"typeset":15,"ubuntu":15,"under":[9,15],"unicod":[4,14],"unique_id":5,"up":15,"updat":15,"us":[0,1,4,5,6,10,14,15],"usepackag":9,"utf":2,"valu":[1,10],"variabl":15,"venv":15,"veri":15,"wa":[1,2],"warn":2,"warranti":0,"webservic":15,"websit":15,"welcom":15,"well":[10,15],"what":15,"where":15,"whether":[0,1,2,13],"while":15,"whom":0,"window":15,"without":[0,15],"work":15,"x_i":15,"x_j":15,"xelatex":[1,2],"xetex":15,"y":15,"your":15},"titles":["<no title>","pyladoc.DocumentWriter","pyladoc.latex.compile","pyladoc.escape_html","pyladoc.latex.escape_text","pyladoc.figure_to_string","pyladoc.latex.from_html","pyladoc.latex.get_equation_code","Classes and functions","pyladoc.latex.inject_latex_command","pyladoc.inject_to_template","pyladoc.latex_to_figure","pyladoc.latex.normalize_label_text","pyladoc.latex.render_pandas_styler_table","pyladoc.latex.to_ascii","Pyladoc"],"titleterms":{"class":8,"compil":2,"contribut":15,"depend":15,"descript":15,"develop":15,"documentwrit":[1,8],"escape_html":3,"escape_text":4,"exampl":15,"featur":15,"figure_to_str":5,"from_html":6,"function":8,"get_equation_cod":7,"guid":15,"inject_latex_command":9,"inject_to_templ":10,"instal":15,"kei":15,"latex":[2,4,6,7,8,9,12,13,14],"latex_to_figur":11,"licens":15,"normalize_label_text":12,"output":15,"primit":15,"pyladoc":[1,2,3,4,5,6,7,9,10,11,12,13,14,15],"render_pandas_styler_t":13,"scenario":15,"submodul":8,"support":15,"to_ascii":14,"usag":15}}) \ No newline at end of file +Search.setIndex({"alltitles":{"Classes and functions":[[8,null]],"Contributing":[[15,"contributing"]],"Dependencies":[[15,"dependencies"]],"Description":[[15,"description"]],"Developer Guide":[[15,"developer-guide"]],"DocumentWriter Class:":[[8,null]],"Example outputs":[[15,"example-outputs"]],"Functions:":[[8,null]],"Installation":[[15,"installation"]],"Key Features":[[15,"key-features"]],"License":[[15,"license"]],"Pyladoc":[[15,null]],"Submodule latex:":[[8,null]],"Supported primitives":[[15,"supported-primitives"]],"Usage":[[15,"usage"]],"Usage Scenarios":[[15,"usage-scenarios"]],"pyladoc.DocumentWriter":[[1,null]],"pyladoc.escape_html":[[3,null]],"pyladoc.figure_to_string":[[5,null]],"pyladoc.inject_to_template":[[10,null]],"pyladoc.latex.compile":[[2,null]],"pyladoc.latex.escape_text":[[4,null]],"pyladoc.latex.from_html":[[6,null]],"pyladoc.latex.get_equation_code":[[7,null]],"pyladoc.latex.inject_latex_command":[[9,null]],"pyladoc.latex.normalize_label_text":[[12,null]],"pyladoc.latex.render_pandas_styler_table":[[13,null]],"pyladoc.latex.to_ascii":[[14,null]],"pyladoc.latex_to_figure":[[11,null]]},"docnames":["LICENSE","_autogenerated/DocumentWriter","_autogenerated/compile","_autogenerated/escape_html","_autogenerated/escape_text","_autogenerated/figure_to_string","_autogenerated/from_html","_autogenerated/get_equation_code","_autogenerated/index","_autogenerated/inject_latex_command","_autogenerated/inject_to_template","_autogenerated/latex_to_figure","_autogenerated/normalize_label_text","_autogenerated/render_pandas_styler_table","_autogenerated/to_ascii","index"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["LICENSE.md","_autogenerated/DocumentWriter.md","_autogenerated/compile.md","_autogenerated/escape_html.md","_autogenerated/escape_text.md","_autogenerated/figure_to_string.md","_autogenerated/from_html.md","_autogenerated/get_equation_code.md","_autogenerated/index.md","_autogenerated/inject_latex_command.md","_autogenerated/inject_to_template.md","_autogenerated/latex_to_figure.md","_autogenerated/normalize_label_text.md","_autogenerated/render_pandas_styler_table.md","_autogenerated/to_ascii.md","index.md"],"indexentries":{"add_diagram() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_diagram",false]],"add_document() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_document",false]],"add_equation() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_equation",false]],"add_h1() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_h1",false]],"add_h2() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_h2",false]],"add_h3() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_h3",false]],"add_html() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_html",false]],"add_markdown() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_markdown",false]],"add_table() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_table",false]],"add_text() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_text",false]],"compile() (in module pyladoc.latex)":[[2,"pyladoc.latex.compile",false]],"documentwriter (class in pyladoc)":[[1,"pyladoc.DocumentWriter",false]],"escape_html() (in module pyladoc)":[[3,"pyladoc.escape_html",false]],"escape_text() (in module pyladoc.latex)":[[4,"pyladoc.latex.escape_text",false]],"figure_to_string() (in module pyladoc)":[[5,"pyladoc.figure_to_string",false]],"from_html() (in module pyladoc.latex)":[[6,"pyladoc.latex.from_html",false]],"get_equation_code() (in module pyladoc.latex)":[[7,"pyladoc.latex.get_equation_code",false]],"inject_latex_command() (in module pyladoc.latex)":[[9,"pyladoc.latex.inject_latex_command",false]],"inject_to_template() (in module pyladoc)":[[10,"pyladoc.inject_to_template",false]],"latex_to_figure() (in module pyladoc)":[[11,"pyladoc.latex_to_figure",false]],"new_field() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.new_field",false]],"normalize_label_text() (in module pyladoc.latex)":[[12,"pyladoc.latex.normalize_label_text",false]],"render_pandas_styler_table() (in module pyladoc.latex)":[[13,"pyladoc.latex.render_pandas_styler_table",false]],"to_ascii() (in module pyladoc.latex)":[[14,"pyladoc.latex.to_ascii",false]],"to_html() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.to_html",false]],"to_latex() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.to_latex",false]],"to_pdf() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.to_pdf",false]]},"objects":{"pyladoc":[[1,0,1,"","DocumentWriter"],[3,2,1,"","escape_html"],[5,2,1,"","figure_to_string"],[10,2,1,"","inject_to_template"],[11,2,1,"","latex_to_figure"]],"pyladoc.DocumentWriter":[[1,1,1,"","add_diagram"],[1,1,1,"","add_document"],[1,1,1,"","add_equation"],[1,1,1,"","add_h1"],[1,1,1,"","add_h2"],[1,1,1,"","add_h3"],[1,1,1,"","add_html"],[1,1,1,"","add_markdown"],[1,1,1,"","add_table"],[1,1,1,"","add_text"],[1,1,1,"","new_field"],[1,1,1,"","to_html"],[1,1,1,"","to_latex"],[1,1,1,"","to_pdf"]],"pyladoc.latex":[[2,2,1,"","compile"],[4,2,1,"","escape_text"],[6,2,1,"","from_html"],[7,2,1,"","get_equation_code"],[9,2,1,"","inject_latex_command"],[12,2,1,"","normalize_label_text"],[13,2,1,"","render_pandas_styler_table"],[14,2,1,"","to_ascii"]]},"objnames":{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","function","Python function"]},"objtypes":{"0":"py:class","1":"py:method","2":"py:function"},"terms":{"":15,"1":[1,5,15],"100":15,"110":15,"12":15,"120":15,"150":15,"2025":0,"8":2,"A":[0,1,2,10],"AND":0,"AS":0,"As":15,"BE":0,"BUT":0,"FOR":0,"For":[1,5,15],"IN":0,"If":[1,5,10],"In":15,"It":15,"NO":0,"NOT":0,"OF":0,"OR":0,"On":15,"THE":0,"TO":0,"The":[0,1,2,3,4,5,6,7,10,13,14,15],"There":15,"To":15,"WITH":0,"abov":0,"accur":15,"action":0,"activ":15,"add":1,"add_diagram":1,"add_docu":1,"add_equ":1,"add_h1":1,"add_h2":1,"add_h3":1,"add_html":1,"add_markdown":[1,15],"add_tabl":[1,15],"add_text":1,"all":0,"allow":12,"alt":5,"alt_text":5,"an":[0,1,7,15],"ani":[0,12,15],"applic":15,"approach":15,"apt":15,"ar":15,"aris":0,"ascii":[5,14],"associ":0,"author":0,"backend":15,"base":1,"base64":[1,5,15],"base64_svg":1,"basic":1,"between":1,"bew":1,"bin":15,"block":[7,15],"bool":[1,5,13],"boolean":2,"both":15,"box":15,"c":0,"calcul":15,"can":[1,5,15],"capabl":15,"caption":[1,13],"case":15,"cd":15,"center":[1,13],"charact":[3,4,10,12,14],"charg":0,"ci":15,"claim":0,"class":1,"clone":15,"code":[1,2,3,6,7,9,13,14,15],"column":1,"com":15,"command":9,"comment":10,"comparison":15,"compil":8,"composit":15,"conda":15,"condit":0,"connect":0,"content":[1,10,15],"contract":0,"convert":[5,6,7,13,14],"copi":0,"copyright":0,"correctli":15,"creat":1,"current":15,"custom":1,"damag":0,"data":15,"datafram":[1,15],"deal":0,"default":[1,10],"detail":15,"determin":5,"dev":15,"df":15,"df_style":13,"diagram":1,"dict":[1,10],"dictionari":[1,10],"directli":10,"directori":15,"displai":[1,15],"distribut":[0,15],"do":0,"doc":[1,15],"docstr":15,"document":[0,1,15],"documentwrit":15,"done":15,"e":[1,15],"each":1,"easi":15,"element":[2,15],"embed":[1,15],"enabl":5,"encod":[1,2,5],"engin":[1,2,15],"ensur":15,"eq":[1,15],"equat":[1,7,15],"equip":15,"equival":14,"error":2,"escap":[3,4,14],"escape_html":8,"escape_text":8,"even":15,"event":0,"everyth":15,"excel":15,"export":[1,15],"express":[0,1],"extra":15,"factor":[1,5],"fals":[1,5,7],"famili":[1,5],"field":[1,10],"fields_dict":[1,10],"fig":[1,5],"figur":[1,5,15],"figure_format":[1,5],"figure_scal":1,"figure_to_str":8,"file":[0,1,2,10,15],"file_path":1,"first":15,"fit":0,"fix":15,"float":[1,5],"focus":15,"follow":[0,15],"font":[5,15],"font_famili":[1,5],"forg":15,"format":[1,5,15],"frac":15,"free":0,"from":0,"from_html":8,"front":1,"furnish":0,"g":[1,15],"gener":[1,5,15],"get":15,"get_equation_cod":8,"git":15,"github":15,"given":[3,4],"grant":0,"graphic":1,"guess":1,"h1":1,"h2":1,"h3":1,"ha":1,"handl":15,"hard":15,"head":[1,15],"herebi":0,"holder":0,"html":[1,3,6,15],"html_code":[6,15],"htmlparser":6,"http":15,"i":[0,1,5,10,15],"id":7,"ij":15,"imag":[1,5],"img":5,"impli":0,"import":15,"includ":[0,5,10,15],"indic":2,"individu":1,"initi":1,"inject":[9,10],"inject_latex_command":8,"inject_to_templ":8,"inlin":[1,15],"input":[9,12],"insert":3,"instanc":1,"intern":[1,10],"internal_templ":10,"intervent":15,"involv":15,"issu":15,"its":14,"j":15,"jinja2":15,"keep":15,"kei":[1,10],"kind":0,"km":15,"kruse":0,"lab":15,"label":[13,15],"labl":12,"lambda":15,"lambda_":15,"lambda_i":15,"last":9,"latex":[1,15],"latex_cod":[2,11],"latex_equ":1,"latex_template_path":1,"latex_to_figur":8,"liabil":0,"liabl":0,"licens":0,"limit":0,"line":9,"line1":15,"line2":15,"line3":15,"linux":15,"list":2,"liter":[1,2,5],"lmodern":15,"local":15,"lot":15,"lualatex":[1,2],"m":15,"machin":15,"manual":15,"markdown":[1,15],"matplotlib":[1,5,15],"merchant":0,"merg":0,"miktex":15,"mit":[0,15],"mix":15,"modifi":0,"multilin":15,"n":15,"name":[1,10,15],"need":15,"new_field":1,"nicola":0,"non":12,"nonannet":15,"none":[1,5,7,11,13],"noninfring":0,"normal":12,"normalize_label_text":8,"notic":0,"number":[1,15],"object":[1,13],"obtain":0,"obvious":15,"often":[4,14],"onli":1,"open":15,"option":15,"other":0,"otherwis":0,"out":[0,15],"output":[1,2,5],"output_fil":2,"overwrit":1,"packag":15,"page":15,"panda":[1,13,15],"pandas_exampl":15,"paragraph":1,"paramet":[1,2,3,4,5,6,7,9,10,12,13,14],"particular":0,"path":[1,2,10],"pd":15,"pdf":[1,2,15],"pdflatex":[1,2],"permiss":0,"permit":0,"person":0,"pgf":[1,5,15],"phi_":15,"pip":15,"place":15,"placehold":[1,10],"pleas":15,"png":[1,5,15],"portion":0,"prefix":[1,10],"prefix_pattern":1,"print":15,"problem":15,"programmat":15,"project":15,"provid":[0,1,9],"publish":0,"pull":15,"purpos":0,"py":15,"pyladoc":8,"pytest":15,"python":15,"random":15,"recommend":15,"ref_id":1,"ref_typ":1,"refer":[1,7,15],"referenc":[1,13],"render":[1,15],"render_pandas_styler_t":8,"replac":[1,10,12,14],"report":15,"repositori":15,"request":15,"requir":15,"restrict":0,"result":15,"return":[1,2,3,4,5,6,7,9,10,11,12,13,14],"right":0,"row1":15,"row2":15,"row3":15,"run":15,"same":15,"san":1,"save":[1,3,5],"scale":[1,5],"scienc":15,"script":15,"section":1,"section_class":1,"see":15,"select":1,"sell":0,"separ":7,"serif":1,"servic":15,"set":15,"setup":15,"shall":0,"show":15,"similar":15,"simpl":1,"singl":15,"size":[1,5,15],"so":0,"softwar":0,"some":15,"some_data":15,"sourc":15,"special":[3,4,12],"specif":15,"start":[9,15],"step":15,"str":[1,2,3,4,5,6,7,9,10,12,13,14],"string":[1,3,4,5,7,10,15],"styler":[1,13],"subject":0,"sublicens":0,"submit":15,"substanti":0,"success":2,"successfulli":1,"sudo":15,"sum_":15,"superior":15,"support":1,"svg":[1,5,15],"tabl":[1,13,15],"table_render":1,"tag":5,"target":15,"tecton":[1,2],"templat":[1,10,15],"template_path":10,"template_str":10,"test":15,"test1":15,"test_html_render1":15,"test_latex_render1":15,"test_rendering_example1_doc":15,"texliv":15,"text":[1,3,4,5,9,12,14,15],"thi":[0,1,5,10,15],"three":2,"tikz":15,"to_ascii":8,"to_html":[1,15],"to_latex":1,"to_pdf":[1,15],"tool":15,"tort":0,"true":[1,13],"tupl":2,"type":[1,2,3,4,5,6,7,9,10,11,12,13,14],"typeset":15,"ubuntu":15,"under":[9,15],"unicod":[4,14],"unique_id":5,"up":15,"updat":15,"us":[0,1,4,5,6,10,14,15],"usepackag":9,"utf":2,"valu":[1,10],"variabl":15,"venv":15,"veri":15,"wa":[1,2],"warn":2,"warranti":0,"web":15,"websit":15,"welcom":15,"well":[10,15],"where":15,"whether":[0,1,2,13],"while":15,"whom":0,"window":15,"without":[0,15],"work":15,"x_i":15,"x_j":15,"xelatex":[1,2],"xetex":15,"y":15,"your":15},"titles":["<no title>","pyladoc.DocumentWriter","pyladoc.latex.compile","pyladoc.escape_html","pyladoc.latex.escape_text","pyladoc.figure_to_string","pyladoc.latex.from_html","pyladoc.latex.get_equation_code","Classes and functions","pyladoc.latex.inject_latex_command","pyladoc.inject_to_template","pyladoc.latex_to_figure","pyladoc.latex.normalize_label_text","pyladoc.latex.render_pandas_styler_table","pyladoc.latex.to_ascii","Pyladoc"],"titleterms":{"class":8,"compil":2,"contribut":15,"depend":15,"descript":15,"develop":15,"documentwrit":[1,8],"escape_html":3,"escape_text":4,"exampl":15,"featur":15,"figure_to_str":5,"from_html":6,"function":8,"get_equation_cod":7,"guid":15,"inject_latex_command":9,"inject_to_templ":10,"instal":15,"kei":15,"latex":[2,4,6,7,8,9,12,13,14],"latex_to_figur":11,"licens":15,"normalize_label_text":12,"output":15,"primit":15,"pyladoc":[1,2,3,4,5,6,7,9,10,11,12,13,14,15],"render_pandas_styler_t":13,"scenario":15,"submodul":8,"support":15,"to_ascii":14,"usag":15}}) \ No newline at end of file