Skip to content

Commit

Permalink
build based on 83e1363
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 23, 2024
1 parent fb402c2 commit 8d8f1eb
Show file tree
Hide file tree
Showing 14 changed files with 15 additions and 15 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.12.0-DEV.1661","generation_timestamp":"2024-11-21T04:05:43","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.12.0-DEV.1682","generation_timestamp":"2024-11-23T20:46:49","documenter_version":"1.8.0"}}
2 changes: 1 addition & 1 deletion dev/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@
io::IO=stderr)</code></pre><p>Installs all non-lazy artifacts from a given <code>(Julia)Artifacts.toml</code> file. <code>package_uuid</code> must be provided to properly support overrides from <code>Overrides.toml</code> entries in depots.</p><p>If <code>include_lazy</code> is set to <code>true</code>, then lazy packages will be installed as well.</p><p>This function is deprecated and should be replaced with the following snippet:</p><pre><code class="language-julia hljs">artifacts = select_downloadable_artifacts(artifacts_toml; platform, include_lazy)
for name in keys(artifacts)
ensure_artifact_installed(name, artifacts[name], artifacts_toml; platform=platform)
end</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is deprecated in Julia 1.6 and will be removed in a future version. Use <code>select_downloadable_artifacts()</code> and <code>ensure_artifact_installed()</code> instead.</p></div></div></div></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Pkg.Artifacts.archive_artifact" href="#Pkg.Artifacts.archive_artifact"><code>Pkg.Artifacts.archive_artifact</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">archive_artifact(hash::SHA1, tarball_path::String; honor_overrides::Bool=false)</code></pre><p>Archive an artifact into a tarball stored at <code>tarball_path</code>, returns the SHA256 of the resultant tarball as a hexadecimal string. Throws an error if the artifact does not exist. If the artifact is overridden, throws an error unless <code>honor_overrides</code> is set.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../repl/">« <strong>11.</strong> REPL Mode Reference</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 04:05">Thursday 21 November 2024</span>. Using Julia version 1.12.0-DEV.1661.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This function is deprecated in Julia 1.6 and will be removed in a future version. Use <code>select_downloadable_artifacts()</code> and <code>ensure_artifact_installed()</code> instead.</p></div></div></div></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Pkg.Artifacts.archive_artifact" href="#Pkg.Artifacts.archive_artifact"><code>Pkg.Artifacts.archive_artifact</code></a><span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">archive_artifact(hash::SHA1, tarball_path::String; honor_overrides::Bool=false)</code></pre><p>Archive an artifact into a tarball stored at <code>tarball_path</code>, returns the SHA256 of the resultant tarball as a hexadecimal string. Throws an error if the artifact does not exist. If the artifact is overridden, throws an error unless <code>honor_overrides</code> is set.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../repl/">« <strong>11.</strong> REPL Mode Reference</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="Saturday 23 November 2024 20:46">Saturday 23 November 2024</span>. Using Julia version 1.12.0-DEV.1682.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/artifacts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,4 @@
function __init__()
p = augment_platform!(HostPlatform())
global my_artifact_dir = @artifact_str(&quot;MyArtifact&quot;, p)
end</code></pre><p>This ensures that the same artifact is used by your code as Pkg attempted to install.</p><p>Artifact selection hooks are only allowed to use <code>Base</code>, <code>Artifacts</code>, <code>Libdl</code>, and <code>TOML</code>. They are not allowed to use any other standard libraries, and they are not allowed to use any packages (including the package to which they belong).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../registries/">« <strong>7.</strong> Registries</a><a class="docs-footer-nextpage" href="../glossary/"><strong>9.</strong> Glossary »</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 04:05">Thursday 21 November 2024</span>. Using Julia version 1.12.0-DEV.1661.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><p>This ensures that the same artifact is used by your code as Pkg attempted to install.</p><p>Artifact selection hooks are only allowed to use <code>Base</code>, <code>Artifacts</code>, <code>Libdl</code>, and <code>TOML</code>. They are not allowed to use any other standard libraries, and they are not allowed to use any packages (including the package to which they belong).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../registries/">« <strong>7.</strong> Registries</a><a class="docs-footer-nextpage" href="../glossary/"><strong>9.</strong> Glossary »</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="Saturday 23 November 2024 20:46">Saturday 23 November 2024</span>. Using Julia version 1.12.0-DEV.1682.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/basedocs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

(@v1.9) pkg&gt; up
Updating `~/.julia/environments/v1.9/Project.toml`
[7876af07] ↑ Example v0.5.1 ⇒ v0.5.3</code></pre><p>We can see that the status output tells us that there is a newer version available and that <code>up</code> upgrades the package.</p><p>For more information about managing packages, see the <a href="https://pkgdocs.julialang.org/v1/managing-packages/">Managing Packages</a> section of the documentation.</p><p>Up to this point, we have covered basic package management: adding, updating, and removing packages.</p><p>You may have noticed the <code>(@v1.9)</code> in the REPL prompt. This lets us know that <code>v1.9</code> is the <strong>active environment</strong>. Different environments can have different totally different packages and versions installed from another environment. The active environment is the environment that will be modified by Pkg commands such as <code>add</code>, <code>rm</code> and <code>update</code>.</p><p>Let&#39;s set up a new environment so we may experiment. To set the active environment, use <code>activate</code>:</p><pre><code class="language-julia-repl hljs">(@v1.9) pkg&gt; activate tutorial
[7876af07] ↑ Example v0.5.1 ⇒ v0.5.3</code></pre><p>We can see that the status output tells us that there is a newer version available and that <code>up</code> upgrades the package.</p><p>For more information about managing packages, see the <a href="https://pkgdocs.julialang.org/v1/managing-packages/">Managing Packages</a> section of the documentation.</p><p>Up to this point, we have covered basic package management: adding, updating, and removing packages.</p><p>You may have noticed the <code>(@v1.9)</code> in the REPL prompt. This lets us know that <code>v1.9</code> is the <strong>active environment</strong>. Different environments can have totally different packages and versions installed from another environment. The active environment is the environment that will be modified by Pkg commands such as <code>add</code>, <code>rm</code> and <code>update</code>.</p><p>Let&#39;s set up a new environment so we may experiment. To set the active environment, use <code>activate</code>:</p><pre><code class="language-julia-repl hljs">(@v1.9) pkg&gt; activate tutorial
[ Info: activating new environment at `~/tutorial/Project.toml`.</code></pre><p>Pkg lets us know we are creating a new environment and that this environment will be stored in the <code>~/tutorial</code> directory. The path to the environment is created relative to the current working directory of the REPL.</p><p>Pkg has also updated the REPL prompt in order to reflect the new active environment:</p><pre><code class="language-julia-repl hljs">(tutorial) pkg&gt;</code></pre><p>We can ask for information about the active environment by using <code>status</code>:</p><pre><code class="language-julia-repl hljs">(tutorial) pkg&gt; status
Status `~/tutorial/Project.toml`
(empty environment)</code></pre><p><code>~/tutorial/Project.toml</code> is the location of the active environment&#39;s <strong>project file</strong>. A project file is a <a href="https://toml.io/en/">TOML</a> file where Pkg stores the packages that have been explicitly installed. Notice this new environment is empty. Let us add some packages and observe:</p><pre><code class="language-julia-repl hljs">(tutorial) pkg&gt; add Example JSON
Expand All @@ -28,4 +28,4 @@
(tutorial) pkg&gt; status
Status `~/tutorial/Project.toml`
[7876af07] Example v0.5.3
[682c06a0] JSON v0.21.3</code></pre><p>We can see that the <code>tutorial</code> environment now contains <code>Example</code> and <code>JSON</code>.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have the same package (at the same version) installed in multiple environments, the package will only be downloaded and stored on the hard drive once. This makes environments very lightweight and effectively free to create. Using only the default environment with a huge number of packages in it is a common beginners mistake in Julia. Learning how to use environments effectively will improve your experience with Julia packages.</p></div></div><p>For more information about environments, see the <a href="https://pkgdocs.julialang.org/v1/environments/">Working with Environments</a> section of the documentation.</p><p>If you are ever stuck, you can ask <code>Pkg</code> for help:</p><pre><code class="language-julia-repl hljs">(@v1.9) pkg&gt; ?</code></pre><p>You should see a list of available commands along with short descriptions. You can ask for more detailed help by specifying a command:</p><pre><code class="language-julia-repl hljs">(@v1.9) pkg&gt; ?develop</code></pre><p>This guide should help you get started with <code>Pkg</code>. <code>Pkg</code> has much more to offer in terms of powerful package management, read the full manual to learn more!</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 04:05">Thursday 21 November 2024</span>. Using Julia version 1.12.0-DEV.1661.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
[682c06a0] JSON v0.21.3</code></pre><p>We can see that the <code>tutorial</code> environment now contains <code>Example</code> and <code>JSON</code>.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have the same package (at the same version) installed in multiple environments, the package will only be downloaded and stored on the hard drive once. This makes environments very lightweight and effectively free to create. Using only the default environment with a huge number of packages in it is a common beginners mistake in Julia. Learning how to use environments effectively will improve your experience with Julia packages.</p></div></div><p>For more information about environments, see the <a href="https://pkgdocs.julialang.org/v1/environments/">Working with Environments</a> section of the documentation.</p><p>If you are ever stuck, you can ask <code>Pkg</code> for help:</p><pre><code class="language-julia-repl hljs">(@v1.9) pkg&gt; ?</code></pre><p>You should see a list of available commands along with short descriptions. You can ask for more detailed help by specifying a command:</p><pre><code class="language-julia-repl hljs">(@v1.9) pkg&gt; ?develop</code></pre><p>This guide should help you get started with <code>Pkg</code>. <code>Pkg</code> has much more to offer in terms of powerful package management, read the full manual to learn more!</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="Saturday 23 November 2024 20:46">Saturday 23 November 2024</span>. Using Julia version 1.12.0-DEV.1682.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 8d8f1eb

Please sign in to comment.