Skip to content

Commit

Permalink
build based on 8d6fce0
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 21, 2024
1 parent 8b2a57a commit 3e9bd1d
Show file tree
Hide file tree
Showing 12 changed files with 14 additions and 14 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.11.1","generation_timestamp":"2024-11-21T15:55:33","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-21T17:12:12","documenter_version":"1.8.0"}}
2 changes: 1 addition & 1 deletion dev/apps.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@
│ %8 = Base.PROGRAM_FILE
│ value@_16 = %8
│ %10 = Base.repr(%8)
...</code></pre><h4 id="Preferences-in-app_dir/share/julia"><a class="docs-heading-anchor" href="#Preferences-in-app_dir/share/julia">Preferences in <code>&lt;app_dir&gt;/share/julia</code></a><a id="Preferences-in-app_dir/share/julia-1"></a><a class="docs-heading-anchor-permalink" href="#Preferences-in-app_dir/share/julia" title="Permalink"></a></h4><p>As described <a href="apps.html#app-preferences">above</a>, a TOML file with all preferences active during the compilation process will be stored with the app bundle. If your preferences may contain confidential information, you can either delete the <code>&lt;app_dir&gt;/share/julia/LocalPreferences.toml</code> file before distributing the app bundle, or suppress the preference file generation by passing <code>include_preferences=false</code> to <code>create_app</code>. Note, however, that if the preference file is not present, any preference loaded in your app at <em>runtime</em> will use their default value (or crash, if no default is provided).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="sysimages.html">« Sysimages</a><a class="docs-footer-nextpage" href="libs.html">Libraries »</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.8.0 on <span class="colophon-date" title="Thursday 21 November 2024 15:55">Thursday 21 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
...</code></pre><h4 id="Preferences-in-app_dir/share/julia"><a class="docs-heading-anchor" href="#Preferences-in-app_dir/share/julia">Preferences in <code>&lt;app_dir&gt;/share/julia</code></a><a id="Preferences-in-app_dir/share/julia-1"></a><a class="docs-heading-anchor-permalink" href="#Preferences-in-app_dir/share/julia" title="Permalink"></a></h4><p>As described <a href="apps.html#app-preferences">above</a>, a TOML file with all preferences active during the compilation process will be stored with the app bundle. If your preferences may contain confidential information, you can either delete the <code>&lt;app_dir&gt;/share/julia/LocalPreferences.toml</code> file before distributing the app bundle, or suppress the preference file generation by passing <code>include_preferences=false</code> to <code>create_app</code>. Note, however, that if the preference file is not present, any preference loaded in your app at <em>runtime</em> will use their default value (or crash, if no default is provided).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="sysimages.html">« Sysimages</a><a class="docs-footer-nextpage" href="libs.html">Libraries »</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.8.0 on <span class="colophon-date" title="Thursday 21 November 2024 17:12">Thursday 21 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/devdocs/binaries_part_2.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,4 @@
Stacktrace:
[1] error(::String) at ./error.jl:33
[2] real_main() at /home/kc/MyApp/MyApp.jl:21
[3] julia_main() at /home/kc/MyApp/MyApp.jl:7</code></pre><h3 id="macOS-considerations"><a class="docs-heading-anchor" href="#macOS-considerations">macOS considerations</a><a id="macOS-considerations-1"></a><a class="docs-heading-anchor-permalink" href="#macOS-considerations" title="Permalink"></a></h3><p>On macOS, instead of <code>$ORIGIN</code> for the <code>rpath</code>, use <code>@executable_path</code>.</p><h3 id="Windows-considerations"><a class="docs-heading-anchor" href="#Windows-considerations">Windows considerations</a><a id="Windows-considerations-1"></a><a class="docs-heading-anchor-permalink" href="#Windows-considerations" title="Permalink"></a></h3><p>On Windows, it is recommended to increase the size of the stack from the default 1 MB to 8MB which can be done by passing the <code>-Wl,--stack,8388608</code> flag. Windows doesn&#39;t have (at least in an as simple way as Linux and macOS) the concept of <code>rpath</code>. The goto solution is to either set the <code>PATH</code> environment variable to the Julia <code>bin</code> folder or alternatively copy paste all the libraries in the Julia <code>bin</code> folder so they sit next to the executable.</p></article><nav class="docs-footer"><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.8.0 on <span class="colophon-date" title="Thursday 21 November 2024 15:55">Thursday 21 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
[3] julia_main() at /home/kc/MyApp/MyApp.jl:7</code></pre><h3 id="macOS-considerations"><a class="docs-heading-anchor" href="#macOS-considerations">macOS considerations</a><a id="macOS-considerations-1"></a><a class="docs-heading-anchor-permalink" href="#macOS-considerations" title="Permalink"></a></h3><p>On macOS, instead of <code>$ORIGIN</code> for the <code>rpath</code>, use <code>@executable_path</code>.</p><h3 id="Windows-considerations"><a class="docs-heading-anchor" href="#Windows-considerations">Windows considerations</a><a id="Windows-considerations-1"></a><a class="docs-heading-anchor-permalink" href="#Windows-considerations" title="Permalink"></a></h3><p>On Windows, it is recommended to increase the size of the stack from the default 1 MB to 8MB which can be done by passing the <code>-Wl,--stack,8388608</code> flag. Windows doesn&#39;t have (at least in an as simple way as Linux and macOS) the concept of <code>rpath</code>. The goto solution is to either set the <code>PATH</code> environment variable to the Julia <code>bin</code> folder or alternatively copy paste all the libraries in the Julia <code>bin</code> folder so they sit next to the executable.</p></article><nav class="docs-footer"><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.8.0 on <span class="colophon-date" title="Thursday 21 November 2024 17:12">Thursday 21 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/devdocs/intro.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/devdocs/relocatable_part_3.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,4 +119,4 @@

function __init__()
libfoo = Libdl.dlopen(LIBFOO_PATH)
end</code></pre><p>The problem here is that <code>deps.jl</code> contains an absolute path to the library and this gets encoded into the source code of the package. If we would store the package in the sysimage and try use it on another system, it would error when initialized since the <code>LIBFOO_PATH</code> variable is not valid on the other system. However, sometimes we need to bundle libraries and data files since the package uses them. Fortunately, there is a plan for that which can be seen in the <a href="https://julialang.org/blog/2019/11/artifacts">blog post about artifacts</a>.</p><p>The idea is that with the new artifact system a file (<code>Artifacts.toml</code>), a package can declaratively list external libraries and files that it needs. In addition, the artifact system provides a way to find these files at runtime in a deterministic way. It is then possible to make sure that all artifacts needed for the package is bundled in the app and can also be found by the package during runtime.</p><p>The details are left out here since they become a bit technical but it should give some incentive to switch to the artifact system.</p></article><nav class="docs-footer"><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.8.0 on <span class="colophon-date" title="Thursday 21 November 2024 15:55">Thursday 21 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><p>The problem here is that <code>deps.jl</code> contains an absolute path to the library and this gets encoded into the source code of the package. If we would store the package in the sysimage and try use it on another system, it would error when initialized since the <code>LIBFOO_PATH</code> variable is not valid on the other system. However, sometimes we need to bundle libraries and data files since the package uses them. Fortunately, there is a plan for that which can be seen in the <a href="https://julialang.org/blog/2019/11/artifacts">blog post about artifacts</a>.</p><p>The idea is that with the new artifact system a file (<code>Artifacts.toml</code>), a package can declaratively list external libraries and files that it needs. In addition, the artifact system provides a way to find these files at runtime in a deterministic way. It is then possible to make sure that all artifacts needed for the package is bundled in the app and can also be found by the package during runtime.</p><p>The details are left out here since they become a bit technical but it should give some incentive to switch to the artifact system.</p></article><nav class="docs-footer"><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.8.0 on <span class="colophon-date" title="Thursday 21 November 2024 17:12">Thursday 21 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/devdocs/sysimages_part_1.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@
0.031504 seconds (441 allocations: 37.383 KiB)

julia&gt; @time CSV.read(&quot;FL_insurance_sample.csv&quot;);
0.021355 seconds (423 allocations: 34.695 KiB)</code></pre><p>And finally, our first time for parsing the CSV-file is close to the second time.</p></article><nav class="docs-footer"><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.8.0 on <span class="colophon-date" title="Thursday 21 November 2024 15:55">Thursday 21 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
0.021355 seconds (423 allocations: 34.695 KiB)</code></pre><p>And finally, our first time for parsing the CSV-file is close to the second time.</p></article><nav class="docs-footer"><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.8.0 on <span class="colophon-date" title="Thursday 21 November 2024 17:12">Thursday 21 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 3e9bd1d

Please sign in to comment.