Skip to content

Commit

Permalink
build based on 1266c99
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 3, 2024
1 parent 970135e commit 76800f8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · UpdateJulia.jl</title><script data-outdated-warner src="assets/warner.js"></script><link rel="canonical" href="https://LilithHafner.github.io/UpdateJulia.jl/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>UpdateJulia.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/LilithHafner/UpdateJulia.jl/blob/master/docs/src/index.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="UpdateJulia"><a class="docs-heading-anchor" href="#UpdateJulia">UpdateJulia</a><a id="UpdateJulia-1"></a><a class="docs-heading-anchor-permalink" href="#UpdateJulia" title="Permalink"></a></h1><p>Prefer the <a href="https://github.com/LilithHafner/UpdateJulia.jl/blob/main/README.md">README</a> for better documentation.</p><p>Documentation for <a href="https://github.com/LilithHafner/UpdateJulia.jl">UpdateJulia</a>.</p><ul><li><a href="#UpdateJulia.insert_path-Tuple{Any, Any, Any}"><code>UpdateJulia.insert_path</code></a></li><li><a href="#UpdateJulia.prefer-Tuple{Union{Missing, VersionNumber}, Union{Missing, VersionNumber}}"><code>UpdateJulia.prefer</code></a></li><li><a href="#UpdateJulia.update_julia"><code>UpdateJulia.update_julia</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="UpdateJulia.insert_path-Tuple{Any, Any, Any}" href="#UpdateJulia.insert_path-Tuple{Any, Any, Any}"><code>UpdateJulia.insert_path</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">insert_path(path, entry, v)</code></pre><p>Insert path entry after valid &amp; preferred julia but before unknown &amp; unpreferred julia</p><p>Insert entry into path following these guidelines</p><ul><li>after versions <code>prefer</code>red over <code>v</code></li><li>before versions <code>v</code> is <code>prefer</code>red over (including unknown versions)</li><li>skip operation if <code>entry</code> already meets above guidelines</li><li>before existing entries for <code>v</code></li><li>as late as possible</li></ul><p>Not part of the public API</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LilithHafner/UpdateJulia.jl/blob/70e4eb6b2ade30e7d1cdb607b31e5ce34b060b8c/src/UpdateJulia.jl#L339-L352">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="UpdateJulia.prefer-Tuple{Union{Missing, VersionNumber}, Union{Missing, VersionNumber}}" href="#UpdateJulia.prefer-Tuple{Union{Missing, VersionNumber}, Union{Missing, VersionNumber}}"><code>UpdateJulia.prefer</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">prefer(v1, v2)</code></pre><p>Whether to prefer v1 over v2.</p><p>Not part of the public API.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LilithHafner/UpdateJulia.jl/blob/70e4eb6b2ade30e7d1cdb607b31e5ce34b060b8c/src/UpdateJulia.jl#L34-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="UpdateJulia.update_julia" href="#UpdateJulia.update_julia"><code>UpdateJulia.update_julia</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">update_julia(version::AbstractString=&quot;&quot;)</code></pre><p>Install the latest version of Julia from https://julialang.org</p><p>If <code>version</code> is provided, installs the latest version that starts with <code>version</code>. If <code>version == &quot;nightly&quot;</code>, then installs the bleeding-edge nightly version.</p><p><strong>Keyword Arguments</strong></p><p>Behavior flags</p><ul><li><p><code>dry_run = false</code> skip the actual download and installation</p></li><li><p><code>verbose = dry_run</code> print the final value of all arguments</p></li><li><p><code>migrate_packages = &lt;upgrading to a later version of Julia without an existing global environment&gt;</code> whether to migrate packages in the default global environment. May be <code>true</code>, <code>false</code>, or <code>:force</code>. Only <code>:force</code> will replace an existing Project.toml</p></li></ul><p>Destination</p><ul><li><code>aliases = [&quot;julia&quot;, &quot;julia-$(v.major).$(v.minor)&quot;, &quot;julia-$v&quot;]</code> which aliases to attempt to create for the installed version of Julia. Regardless, will not replace stable versions with less stable versions or newer versions with older versions of the same stability.</li><li><code>systemwide = true</code> install for all users, <code>false</code> only installs for current user.</li><li><code>install_location = systemwide ? &quot;/opt&quot; or &quot;/opt/hostedtoolcache/julia/1.10.0&quot; : &quot;/home/runner/.local&quot;</code> directory to put installed binaries</li><li><code>bin = systemwide ? &quot;/usr/local/bin&quot; : &quot;/home/runner/.local/bin&quot;</code> directory to store links to the binaries</li></ul><p>Source</p><ul><li><p><code>os_str = &quot;linux&quot;</code> string representation of the operating system: &quot;linux&quot;, &quot;mac&quot;, &quot;winnt&quot;, or &quot;freebsd&quot;.</p></li><li><p><code>arch = &quot;x86_64&quot;</code> string representation of the CPU architecture: &quot;x86_64&quot;, &quot;i686&quot;, &quot;aarch64&quot;, &quot;armv7l&quot;, or &quot;powerpc64le&quot;.</p></li><li><p><code>v = ...</code> the <code>VersionNumber</code> to install</p></li><li><p><code>url = ...</code> URL to download that version from, if you explicitly set <code>url</code>, also explicitly set <code>v</code> lest they differ</p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LilithHafner/UpdateJulia.jl/blob/70e4eb6b2ade30e7d1cdb607b31e5ce34b060b8c/src/UpdateJulia.jl#L133-L160">source</a></section></article></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="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 0.27.10 on <span class="colophon-date" title="Wednesday 3 January 2024 14:24">Wednesday 3 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · UpdateJulia.jl</title><script data-outdated-warner src="assets/warner.js"></script><link rel="canonical" href="https://LilithHafner.github.io/UpdateJulia.jl/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.039/juliamono-regular.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>UpdateJulia.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/LilithHafner/UpdateJulia.jl/blob/master/docs/src/index.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="UpdateJulia"><a class="docs-heading-anchor" href="#UpdateJulia">UpdateJulia</a><a id="UpdateJulia-1"></a><a class="docs-heading-anchor-permalink" href="#UpdateJulia" title="Permalink"></a></h1><p>Prefer the <a href="https://github.com/LilithHafner/UpdateJulia.jl/blob/main/README.md">README</a> for better documentation.</p><p>Documentation for <a href="https://github.com/LilithHafner/UpdateJulia.jl">UpdateJulia</a>.</p><ul><li><a href="#UpdateJulia.insert_path-Tuple{Any, Any, Any}"><code>UpdateJulia.insert_path</code></a></li><li><a href="#UpdateJulia.prefer-Tuple{Union{Missing, VersionNumber}, Union{Missing, VersionNumber}}"><code>UpdateJulia.prefer</code></a></li><li><a href="#UpdateJulia.update_julia"><code>UpdateJulia.update_julia</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="UpdateJulia.insert_path-Tuple{Any, Any, Any}" href="#UpdateJulia.insert_path-Tuple{Any, Any, Any}"><code>UpdateJulia.insert_path</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">insert_path(path, entry, v)</code></pre><p>Insert path entry after valid &amp; preferred julia but before unknown &amp; unpreferred julia</p><p>Insert entry into path following these guidelines</p><ul><li>after versions <code>prefer</code>red over <code>v</code></li><li>before versions <code>v</code> is <code>prefer</code>red over (including unknown versions)</li><li>skip operation if <code>entry</code> already meets above guidelines</li><li>before existing entries for <code>v</code></li><li>as late as possible</li></ul><p>Not part of the public API</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LilithHafner/UpdateJulia.jl/blob/1266c991f032b28a958fae3c413ddd9361bf0e2a/src/UpdateJulia.jl#L339-L352">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="UpdateJulia.prefer-Tuple{Union{Missing, VersionNumber}, Union{Missing, VersionNumber}}" href="#UpdateJulia.prefer-Tuple{Union{Missing, VersionNumber}, Union{Missing, VersionNumber}}"><code>UpdateJulia.prefer</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">prefer(v1, v2)</code></pre><p>Whether to prefer v1 over v2.</p><p>Not part of the public API.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LilithHafner/UpdateJulia.jl/blob/1266c991f032b28a958fae3c413ddd9361bf0e2a/src/UpdateJulia.jl#L34-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="UpdateJulia.update_julia" href="#UpdateJulia.update_julia"><code>UpdateJulia.update_julia</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">update_julia(version::AbstractString=&quot;&quot;)</code></pre><p>Install the latest version of Julia from https://julialang.org</p><p>If <code>version</code> is provided, installs the latest version that starts with <code>version</code>. If <code>version == &quot;nightly&quot;</code>, then installs the bleeding-edge nightly version.</p><p><strong>Keyword Arguments</strong></p><p>Behavior flags</p><ul><li><p><code>dry_run = false</code> skip the actual download and installation</p></li><li><p><code>verbose = dry_run</code> print the final value of all arguments</p></li><li><p><code>migrate_packages = &lt;upgrading to a later version of Julia without an existing global environment&gt;</code> whether to migrate packages in the default global environment. May be <code>true</code>, <code>false</code>, or <code>:force</code>. Only <code>:force</code> will replace an existing Project.toml</p></li></ul><p>Destination</p><ul><li><code>aliases = [&quot;julia&quot;, &quot;julia-$(v.major).$(v.minor)&quot;, &quot;julia-$v&quot;]</code> which aliases to attempt to create for the installed version of Julia. Regardless, will not replace stable versions with less stable versions or newer versions with older versions of the same stability.</li><li><code>systemwide = true</code> install for all users, <code>false</code> only installs for current user.</li><li><code>install_location = systemwide ? &quot;/opt&quot; or &quot;/opt/hostedtoolcache/julia/1.10.0&quot; : &quot;/home/runner/.local&quot;</code> directory to put installed binaries</li><li><code>bin = systemwide ? &quot;/usr/local/bin&quot; : &quot;/home/runner/.local/bin&quot;</code> directory to store links to the binaries</li></ul><p>Source</p><ul><li><p><code>os_str = &quot;linux&quot;</code> string representation of the operating system: &quot;linux&quot;, &quot;mac&quot;, &quot;winnt&quot;, or &quot;freebsd&quot;.</p></li><li><p><code>arch = &quot;x86_64&quot;</code> string representation of the CPU architecture: &quot;x86_64&quot;, &quot;i686&quot;, &quot;aarch64&quot;, &quot;armv7l&quot;, or &quot;powerpc64le&quot;.</p></li><li><p><code>v = ...</code> the <code>VersionNumber</code> to install</p></li><li><p><code>url = ...</code> URL to download that version from, if you explicitly set <code>url</code>, also explicitly set <code>v</code> lest they differ</p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/LilithHafner/UpdateJulia.jl/blob/1266c991f032b28a958fae3c413ddd9361bf0e2a/src/UpdateJulia.jl#L133-L160">source</a></section></article></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="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 0.27.10 on <span class="colophon-date" title="Saturday 3 February 2024 00:27">Saturday 3 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 76800f8

Please sign in to comment.