Skip to content

Commit

Permalink
build based on 635b59d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Apr 23, 2024
1 parent a368a93 commit 0dadfde
Show file tree
Hide file tree
Showing 16 changed files with 2,283 additions and 2,620 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-02T11:18:41","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-23T07:52:10","documenter_version":"1.4.0"}}
6 changes: 3 additions & 3 deletions dev/api/index.html

Large diffs are not rendered by default.

458 changes: 0 additions & 458 deletions dev/example_makie/13c78a94.svg

This file was deleted.

494 changes: 0 additions & 494 deletions dev/example_makie/2c66e769.svg

This file was deleted.

467 changes: 467 additions & 0 deletions dev/example_makie/36755832.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
526 changes: 0 additions & 526 deletions dev/example_makie/444c1e53.svg

This file was deleted.

443 changes: 443 additions & 0 deletions dev/example_makie/4f0b73db.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
562 changes: 0 additions & 562 deletions dev/example_makie/75c8b73c.svg

This file was deleted.

405 changes: 405 additions & 0 deletions dev/example_makie/83a5d547.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
488 changes: 488 additions & 0 deletions dev/example_makie/85fe8870.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
533 changes: 0 additions & 533 deletions dev/example_makie/c88d1d21.svg

This file was deleted.

433 changes: 433 additions & 0 deletions dev/example_makie/d35d23d8.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions dev/example_makie/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
return fig
end

plot_data(data)</code></pre><img src="2c66e769.svg" alt="Example block output"/><p>This plot looks fine here in the documentation, but when you imagine it as a full-width plot in a paper the fonts are much too large. It&#39;s easy to fix these with TuePlots.jl!</p><h2 id="Creating-and-using-Makie-Themes-with-TuePlots.jl"><a class="docs-heading-anchor" href="#Creating-and-using-Makie-Themes-with-TuePlots.jl">Creating and using Makie Themes with TuePlots.jl</a><a id="Creating-and-using-Makie-Themes-with-TuePlots.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Creating-and-using-Makie-Themes-with-TuePlots.jl" title="Permalink"></a></h2><p>All we have to do is create a Makie <code>Theme</code> from one of the available settings:</p><pre><code class="language-julia hljs">T = Theme(
plot_data(data)</code></pre><img src="d35d23d8.svg" alt="Example block output"/><p>This plot looks fine here in the documentation, but when you imagine it as a full-width plot in a paper the fonts are much too large. It&#39;s easy to fix these with TuePlots.jl!</p><h2 id="Creating-and-using-Makie-Themes-with-TuePlots.jl"><a class="docs-heading-anchor" href="#Creating-and-using-Makie-Themes-with-TuePlots.jl">Creating and using Makie Themes with TuePlots.jl</a><a id="Creating-and-using-Makie-Themes-with-TuePlots.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Creating-and-using-Makie-Themes-with-TuePlots.jl" title="Permalink"></a></h2><p>All we have to do is create a Makie <code>Theme</code> from one of the available settings:</p><pre><code class="language-julia hljs">T = Theme(
TuePlots.SETTINGS[:ICML];
font = true,
fontsize = true,
Expand Down Expand Up @@ -44,7 +44,7 @@
titlefont =&gt; Times
resolution =&gt; (487.822, 301.491)</code></pre><p>We can use <code>T</code> like any Makie Theme (see also the <a href="https://makie.juliaplots.org/stable/documentation/theming/">Makie Theming documentation</a>):</p><pre><code class="language-julia hljs">with_theme(T) do
plot_data(data)
end</code></pre><img src="13c78a94.svg" alt="Example block output"/><p>Fonts and fontsizes are correct now, and the figure size fits perfectly into LaTeX: You can directly include it with <code>\includegraphics{plot.pdf}</code>, <em>without even setting some <code>[width=\linewidth]</code></em>!</p><h2 id="Combining-TuePlots.jl&#39;s-themes-with-your-custom-theme"><a class="docs-heading-anchor" href="#Combining-TuePlots.jl&#39;s-themes-with-your-custom-theme">Combining TuePlots.jl&#39;s themes with your custom theme</a><a id="Combining-TuePlots.jl&#39;s-themes-with-your-custom-theme-1"></a><a class="docs-heading-anchor-permalink" href="#Combining-TuePlots.jl&#39;s-themes-with-your-custom-theme" title="Permalink"></a></h2><p>But we&#39;re not quite happy with the result yet. Let&#39;s make the plot more beautiful, e.g. by making lines thinner and reducing the padding. As one would normally do with Makie, we just create another Theme - which we then merge with the previous one:</p><pre><code class="language-julia hljs">T2 = Theme(
end</code></pre><img src="83a5d547.svg" alt="Example block output"/><p>Fonts and fontsizes are correct now, and the figure size fits perfectly into LaTeX: You can directly include it with <code>\includegraphics{plot.pdf}</code>, <em>without even setting some <code>[width=\linewidth]</code></em>!</p><h2 id="Combining-TuePlots.jl&#39;s-themes-with-your-custom-theme"><a class="docs-heading-anchor" href="#Combining-TuePlots.jl&#39;s-themes-with-your-custom-theme">Combining TuePlots.jl&#39;s themes with your custom theme</a><a id="Combining-TuePlots.jl&#39;s-themes-with-your-custom-theme-1"></a><a class="docs-heading-anchor-permalink" href="#Combining-TuePlots.jl&#39;s-themes-with-your-custom-theme" title="Permalink"></a></h2><p>But we&#39;re not quite happy with the result yet. Let&#39;s make the plot more beautiful, e.g. by making lines thinner and reducing the padding. As one would normally do with Makie, we just create another Theme - which we then merge with the previous one:</p><pre><code class="language-julia hljs">T2 = Theme(
figure_padding = 5,
Axis = (
spinewidth = 0.5,
Expand All @@ -62,7 +62,7 @@

with_theme(merge(T, T2)) do
plot_data(data)
end</code></pre><img src="c88d1d21.svg" alt="Example block output"/><p>Voilà! And if you like this setting, you can also reduce padding and line widths with less effort by just setting <code>thinned=true</code> when creating the Theme.</p><h2 id="Adjust-heights-to-fit-simple-subplot-layouts"><a class="docs-heading-anchor" href="#Adjust-heights-to-fit-simple-subplot-layouts">Adjust heights to fit simple subplot layouts</a><a id="Adjust-heights-to-fit-simple-subplot-layouts-1"></a><a class="docs-heading-anchor-permalink" href="#Adjust-heights-to-fit-simple-subplot-layouts" title="Permalink"></a></h2><p>In the example above, TuePlots.jl conveniently set the figure size such that the figure nicely fits into the paper. But the result does not look as nice when we want to have multiple subplots:</p><pre><code class="language-julia hljs">data = cumsum(randn(Xoshiro(2), 4, 201), dims = 2)
end</code></pre><img src="4f0b73db.svg" alt="Example block output"/><p>Voilà! And if you like this setting, you can also reduce padding and line widths with less effort by just setting <code>thinned=true</code> when creating the Theme.</p><h2 id="Adjust-heights-to-fit-simple-subplot-layouts"><a class="docs-heading-anchor" href="#Adjust-heights-to-fit-simple-subplot-layouts">Adjust heights to fit simple subplot layouts</a><a id="Adjust-heights-to-fit-simple-subplot-layouts-1"></a><a class="docs-heading-anchor-permalink" href="#Adjust-heights-to-fit-simple-subplot-layouts" title="Permalink"></a></h2><p>In the example above, TuePlots.jl conveniently set the figure size such that the figure nicely fits into the paper. But the result does not look as nice when we want to have multiple subplots:</p><pre><code class="language-julia hljs">data = cumsum(randn(Xoshiro(2), 4, 201), dims = 2)

function simple_subplots(data)
fig = Figure()
Expand All @@ -75,7 +75,7 @@

with_theme(T) do
simple_subplots(data)
end</code></pre><img src="75c8b73c.svg" alt="Example block output"/><p>The overall figure size is still the same as above, the width fits the paper and the height is chosen such that the resulting figure has a golden ratio. But as a result, the individual subplots became too tall. Instead, we might want to keep the golden ratio of each subplot, and choose the height accordingly. You can do this by specifying <code>nrows=1</code> and <code>ncols=3</code> when creating the Makie theme:</p><pre><code class="language-julia hljs">T2 = Theme(
end</code></pre><img src="85fe8870.svg" alt="Example block output"/><p>The overall figure size is still the same as above, the width fits the paper and the height is chosen such that the resulting figure has a golden ratio. But as a result, the individual subplots became too tall. Instead, we might want to keep the golden ratio of each subplot, and choose the height accordingly. You can do this by specifying <code>nrows=1</code> and <code>ncols=3</code> when creating the Makie theme:</p><pre><code class="language-julia hljs">T2 = Theme(
TuePlots.SETTINGS[:ICML];
font = true,
fontsize = true,
Expand All @@ -86,4 +86,4 @@
)
with_theme(T2) do
simple_subplots(data)
end</code></pre><img src="444c1e53.svg" alt="Example block output"/><p>There we go! This way, each individual subplot has the golden ratio.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../example_plotsjl/">Example with Plots.jl (experimental) »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Saturday 2 March 2024 11:18">Saturday 2 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><img src="36755832.svg" alt="Example block output"/><p>There we go! This way, each individual subplot has the golden ratio.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../example_plotsjl/">Example with Plots.jl (experimental) »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.0 on <span class="colophon-date" title="Tuesday 23 April 2024 07:52">Tuesday 23 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 0dadfde

Please sign in to comment.