Skip to content

Commit dc50ff9

Browse files
author
Documenter.jl
committed
build based on aad9cb9
1 parent ce74e25 commit dc50ff9

File tree

18 files changed

+224
-36
lines changed

18 files changed

+224
-36
lines changed

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.5","generation_timestamp":"2025-07-04T21:42:37","documenter_version":"1.13.0"}}
1+
{"documenter":{"julia_version":"1.11.5","generation_timestamp":"2025-07-05T01:10:13","documenter_version":"1.13.0"}}

dev/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@
2020
highlighters = [hl_10, hl_p, hl_v],
2121
table_format = table_format_format = TextTableFormat(borders = text_table_borders__unicode_rounded)
2222
)</code></pre><p><img src="welcome_figure.svg" alt="Welcome figure"/></p><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><pre><code class="language-julia-repl hljs">julia&gt; using Pkg
23-
julia&gt; Pkg.add(&quot;PrettyTables&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/quick_start/">Quick Start »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.13.0 on <span class="colophon-date" title="Friday 4 July 2025 21:42">Friday 4 July 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
23+
julia&gt; Pkg.add(&quot;PrettyTables&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/quick_start/">Quick Start »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.13.0 on <span class="colophon-date" title="Saturday 5 July 2025 01:10">Saturday 5 July 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/lib/library/index.html

Lines changed: 24 additions & 24 deletions
Large diffs are not rendered by default.

dev/man/fmt__latex_sn.png

0 Bytes
Loading

dev/man/html/html_backend/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515

1616
highlighters = [hl_gt5, hl_lt5]</code></pre><h2 id="HTML-Table-Format"><a class="docs-heading-anchor" href="#HTML-Table-Format">HTML Table Format</a><a id="HTML-Table-Format-1"></a><a class="docs-heading-anchor-permalink" href="#HTML-Table-Format" title="Permalink"></a></h2><p>The HTML table format is defined using an object of type <a href="../../../lib/library/#PrettyTables.HtmlTableFormat"><code>HtmlTableFormat</code></a> that contains the following fields:</p><ul><li><code>css::String</code>: CSS to be injected at the end of the <code>&lt;style&gt;</code> section.</li><li><code>table_width::String</code>: Table width.</li></ul><p>Notice that this format is only applied if <code>stand_alone = true</code>.</p><h2 id="HTML-Table-Style"><a class="docs-heading-anchor" href="#HTML-Table-Style">HTML Table Style</a><a id="HTML-Table-Style-1"></a><a class="docs-heading-anchor-permalink" href="#HTML-Table-Style" title="Permalink"></a></h2><p>The HTML table style is defined using an object of type <a href="../../../lib/library/#PrettyTables.HtmlTableStyle"><code>HtmlTableStyle</code></a> that contains the following fields:</p><ul><li><code>top_left_string::Vector{HtmlPair}</code>: Style for the top left string.</li><li><code>top_right_string::Vector{HtmlPair}</code>: Style for the top right string.</li><li><code>table::Vector{HtmlPair}</code>: Style for the table.</li><li><code>title::Vector{HtmlPair}</code>: Style for the title.</li><li><code>subtitle::Vector{HtmlPair}</code>: Style for the subtitle.</li><li><code>row_number_label::Vector{HtmlPair}</code>: Style for the row number label.</li><li><code>row_number::Vector{HtmlPair}</code>: Style for the row number.</li><li><code>stubhead_label::Vector{HtmlPair}</code>: Style for the stubhead label.</li><li><code>row_label::Vector{HtmlPair}</code>: Style for the row label.</li><li><code>row_group_label::Vector{HtmlPair}</code>: Style for the row group label.</li><li><code>first_line_column_label::Vector{HtmlPair}</code>: Style for the first line of the column labels.</li><li><code>column_label::Vector{HtmlPair}</code>: Style for the column label.</li><li><code>first_line_merged_column_label::Vector{HtmlPair}</code>: Style for the merged cells at the first column label line.</li><li><code>merged_column_label::Vector{HtmlPair}</code>: Style for the merged cells at the rest of the column labels.</li><li><code>summary_row_cell::Vector{HtmlPair}</code>: Style for the summary row cell.</li><li><code>summary_row_label::Vector{HtmlPair}</code>: Style for the summary row label.</li><li><code>footnote::Vector{HtmlPair}</code>: Style for the footnote.</li><li><code>source_notes::Vector{HtmlPair}</code>: Style for the source notes.</li><li><code>first_line_of_column_labels::Vector{HtmlPair}</code>: Style for the first line of the column labels.</li></ul><p>Each field is a vector of <a href="@ref"><code>HtmlPair</code></a>, <em>i.e.</em> <code>Pair{String, String}</code>, describing properties and values compatible with the HTML style attribute.</p><p>For example, we if want that the stubhead label is bold and red, we must define:</p><pre><code class="language-julia hljs">style = HtmlTableStyle(
1717
stubhead_label = [&quot;font-weight&quot; =&gt; &quot;bold&quot;, &quot;color&quot; =&gt; &quot;red&quot;]
18-
)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../text/text_examples/">« Examples</a><a class="docs-footer-nextpage" href="../../latex/latex_backend/">LaTeX Backend »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.13.0 on <span class="colophon-date" title="Friday 4 July 2025 21:42">Friday 4 July 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
18+
)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../text/text_examples/">« Examples</a><a class="docs-footer-nextpage" href="../../latex/latex_backend/">LaTeX Backend »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.13.0 on <span class="colophon-date" title="Saturday 5 July 2025 01:10">Saturday 5 July 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/man/latex/latex_backend/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111

1212
highlighters = [hl_gt5, hl_lt5]</code></pre><h2 id="LaTeX-Table-Format"><a class="docs-heading-anchor" href="#LaTeX-Table-Format">LaTeX Table Format</a><a id="LaTeX-Table-Format-1"></a><a class="docs-heading-anchor-permalink" href="#LaTeX-Table-Format" title="Permalink"></a></h2><p>The LaTeX table format is defined using an object of type <a href="../../../lib/library/#PrettyTables.LatexTableFormat"><code>LatexTableFormat</code></a> that contains the following fields:</p><ul><li><code>borders::LatexTableBorders</code>: Format of the borders.</li><li><code>horizontal_line_at_beginning::Bool</code>: If <code>true</code>, a horizontal line will be drawn at the beginning of the table.</li><li><code>horizontal_line_after_column_labels::Bool</code>: If <code>true</code>, a horizontal line will be drawn after the column labels.</li><li><code>horizontal_lines_at_data_rows::Union{Symbol, Vector{Int}}</code>: A horizontal line will be drawn after each data row index listed in this vector. If the symbol <code>:all</code> is passed, a horizontal line will be drawn after every data column. If the symbol <code>:none</code> is passed, no horizontal lines will be drawn after the data rows.</li><li><code>horizontal_line_before_row_group_label::Bool</code>: If <code>true</code>, a horizontal line will be drawn before the row group label.</li><li><code>horizontal_line_after_row_group_label::Bool</code>: If <code>true</code>, a horizontal line will be drawn after the row group label.</li><li><code>horizontal_line_after_data_rows::Bool</code>: If <code>true</code>, a horizontal line will be drawn after the data rows.</li><li><code>horizontal_line_after_summary_rows::Bool</code>: If <code>true</code>, a horizontal line will be drawn after the summary rows.</li><li><code>vertical_line_at_beginning::Bool</code>: If <code>true</code>, a vertical line will be drawn at the beginning of the table.</li><li><code>vertical_line_after_row_number_column::Bool</code>: If <code>true</code>, a vertical line will be drawn after the row number column.</li><li><code>vertical_line_after_row_label_column::Bool</code>: If <code>true</code>, a vertical line will be drawn after the row label column.</li><li><code>vertical_lines_at_data_columns::Union{Symbol, Vector{Int}}</code>: A vertical line will be drawn after each data column index listed in this vector. If the symbol <code>:all</code> is passed, a vertical line will be drawn after every data column. If the symbol <code>:none</code> is passed, no vertical lines will be drawn after the data columns.</li><li><code>vertical_line_after_data_columns::Bool</code>: If <code>true</code>, a vertical line will be drawn after the data columns.</li><li><code>vertical_line_after_continuation_column::Bool</code>: If <code>true</code>, a vertical line will be drawn after the continuation column.</li></ul><p>We provide a few helpers to configure the table format. For more information, see the documentation of the following macros:</p><ul><li><a href="../../../lib/library/#PrettyTables.@latex__all_horizontal_lines-Tuple{}"><code>@latex__all_horizontal_lines</code></a>.</li><li><a href="../../../lib/library/#PrettyTables.@latex__all_vertical_lines-Tuple{}"><code>@latex__all_vertical_lines</code></a>.</li><li><a href="../../../lib/library/#PrettyTables.@latex__no_horizontal_lines-Tuple{}"><code>@latex__no_horizontal_lines</code></a>.</li><li><a href="../../../lib/library/#PrettyTables.@latex__no_vertical_lines-Tuple{}"><code>@latex__no_vertical_lines</code></a>.</li></ul><h2 id="LaTeX-Table-Style"><a class="docs-heading-anchor" href="#LaTeX-Table-Style">LaTeX Table Style</a><a id="LaTeX-Table-Style-1"></a><a class="docs-heading-anchor-permalink" href="#LaTeX-Table-Style" title="Permalink"></a></h2><p>The LaTeX table style is defined using an object of type <a href="../../../lib/library/#PrettyTables.LatexTableStyle"><code>LatexTableStyle</code></a> that contains the following fields:</p><ul><li><code>title::LatexEnvironments</code>: Latex environments with the style for the title.</li><li><code>subtitle::LatexEnvironments</code>: Latex environments with the style for the subtitle.</li><li><code>row_number_label::LatexEnvironments</code>: Latex environments with the style for the row number label.</li><li><code>row_number::LatexEnvironments</code>: Latex environments with the style for the row numbers.</li><li><code>stubhead_label::LatexEnvironments</code>: Latex environments with the style for the stubhead label.</li><li><code>row_label::LatexEnvironments</code>: Latex environments with the style for the row labels.</li><li><code>row_group_label::LatexEnvironments</code>: Latex environments with the style for the row group label.</li><li><code>first_line_column_label::LatexEnvironments</code>: Latex environments with the style for the first column label lines.</li><li><code>column_label::LatexEnvironments</code>: Latex environments with the style for the rest of the column labels.</li><li><code>first_line_merged_column_label::LatexEnvironments</code>: Latex environments with the style for the merged cells at the first column label line.</li><li><code>merged_column_label::LatexEnvironments</code>: Latex environments with the style for the merged cells at the rest of the column labels.</li><li><code>summary_row_cell::LatexEnvironments</code>: Latex environments with the style for the summary row cell.</li><li><code>summary_row_label::LatexEnvironments</code>: Latex environments with the style for the summary row label.</li><li><code>footnote::LatexEnvironments</code>: Latex environments with the style for the footnotes.</li><li><code>source_note::LatexEnvironments</code>: Latex environments with the style for the source notes.</li><li><code>omitted_cell_summary::LatexEnvironments</code>: Latex environments with the style for the omitted cell summary.</li></ul><p>Each field is a <code>LatexEnvironments</code> object, which is a vector of strings with the LaTeX environments to be applied to the corresponding element.</p><p>For example, if we want to make the stubhead label bold and red, we must define:</p><pre><code class="language-julia hljs">style = LatexTableStyle(
1313
stubhead_label = [&quot;textbf&quot;, &quot;color{red}&quot;]
14-
)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../html/html_backend/">« HTML</a><a class="docs-footer-nextpage" href="../latex_examples/">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.13.0 on <span class="colophon-date" title="Friday 4 July 2025 21:42">Friday 4 July 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
14+
)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../html/html_backend/">« HTML</a><a class="docs-footer-nextpage" href="../latex_examples/">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.13.0 on <span class="colophon-date" title="Saturday 5 July 2025 01:10">Saturday 5 July 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/man/latex/latex_example_01.png

0 Bytes
Loading

dev/man/latex/latex_example_02.png

0 Bytes
Loading

dev/man/latex/latex_example_03.png

0 Bytes
Loading

0 commit comments

Comments
 (0)