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

capital/small letters for latex in the readme fixed

This commit is contained in:
Nicolas 2025-04-13 12:18:28 +02:00
parent 4efffdceca
commit ded3617fc6
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -2,7 +2,7 @@
## Description ## Description
Pyladoc is a python package for programmatically generating HTML and Pyladoc is a python package for programmatically generating HTML and
PDF/LaTex output. This package targets specifically applications where reports PDF/LaTeX output. This package targets specifically applications where reports
or results with Pandas-tables and Matplotlib-figures are generated programmatically or results with Pandas-tables and Matplotlib-figures are generated programmatically
to be displayed as website and as PDF document without any manual formatting to be displayed as website and as PDF document without any manual formatting
steps. steps.
@ -11,31 +11,31 @@ 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 where a lot of calculations and data handling is done but not a lot of
document text needs to be displayed. document text needs to be displayed.
As backend for PDF generation LaTex is used. There are excellent engines for As backend for PDF generation LaTeX is used. There are excellent engines for
rendering HTML to PDF available, but even if there is no requirement for an rendering HTML to PDF available, but even if there is no requirement for an
accurate typesetting, placing programmatically content of variable accurate typesetting, placing programmatically content of variable
composition and sizes on fixed size pages without manual intervention composition and element sizes on fixed size pages without manual intervention
is a hard problem that LaTeX is very capable of. is a hard problem that LaTeX is very capable of.
## Example outputs ## Example outputs
The following documents are generated by [tests/test_rendering_example_doc.py](tests/test_rendering_example_doc.py): The following documents are generated by [tests/test_rendering_example_doc.py](tests/test_rendering_example_doc.py):
- HTML: [test_html_render.html](https://html-preview.github.io/?url=https://github.com/Nonannet/pyladoc/blob/main/tests/out/test_html_render.html) - HTML: [test_html_render.html](https://html-preview.github.io/?url=https://github.com/Nonannet/pyladoc/blob/main/tests/out/test_html_render.html)
- PDF: [test_latex_render.pdf](https://raw.githubusercontent.com/Nonannet/pyladoc/refs/heads/main/tests/out/test_latex_render.pdf) - PDF: [test_latex_render.pdf](https://raw.githubusercontent.com/Nonannet/pyladoc/refs/heads/main/tests/out/test_LaTeX_render.pdf)
### Sported primitives ### Sported primitives
- Text (can be Markdown or HTML formatted) - Text (can be Markdown or HTML formatted)
- Headings - Headings
- Tables (Pandas, Markdown or HTML) - Tables (Pandas, Markdown or HTML)
- Matplotlib figures - Matplotlib figures
- LaTex equations - LaTeX equations
- Named references for figures, tables and equation - Named references for figures, tables and equation
### Key Features ### Key Features
- HTML and PDF/LaTex rendering of the same document - HTML and PDF/LaTeX rendering of the same document
- Single file output including figures - Single file output including figures
- Figure and equation embedding in HTML by inline SVG, SVG in Base64 or PNG in Base64 - Figure and equation embedding in HTML by inline SVG, SVG in Base64 or PNG in Base64
- Figure embedding in LaTex as PGF/TikZ - Figure embedding in LaTeX as PGF/TikZ
### Usage Scenarios ### Usage Scenarios
- Webservices - Webservices