Skip to content

Commit

Permalink
build based on 07739f5
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 8, 2023
1 parent 634d1b1 commit bfbe33b
Show file tree
Hide file tree
Showing 14 changed files with 35 additions and 35 deletions.
44 changes: 22 additions & 22 deletions dev/api/index.html

Large diffs are not rendered by default.

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("MyArtifact", 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="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.25 on <span class="colophon-date" title="Tuesday 8 August 2023 18:50">Tuesday 8 August 2023</span>. Using Julia version 1.11.0-DEV.240.</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="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.25 on <span class="colophon-date" title="Tuesday 8 August 2023 22:38">Tuesday 8 August 2023</span>. Using Julia version 1.11.0-DEV.241.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/basedocs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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. Only using 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="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.25 on <span class="colophon-date" title="Tuesday 8 August 2023 18:50">Tuesday 8 August 2023</span>. Using Julia version 1.11.0-DEV.240.</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. Only using 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="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.25 on <span class="colophon-date" title="Tuesday 8 August 2023 22:38">Tuesday 8 August 2023</span>. Using Julia version 1.11.0-DEV.241.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/compatibility/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@
PkgA = &quot;0.2 - 0.5&quot; # 0.2.0 - 0.5.* = [0.2.0, 0.6.0)
PkgA = &quot;0.2 - 0&quot; # 0.2.0 - 0.*.* = [0.2.0, 1.0.0)</code></pre><h2 id="Fixing-conflicts"><a class="docs-heading-anchor" href="#Fixing-conflicts">Fixing conflicts</a><a id="Fixing-conflicts-1"></a><a class="docs-heading-anchor-permalink" href="#Fixing-conflicts" title="Permalink"></a></h2><p>Version conflicts were introduced previously with an <a href="../managing-packages/#conflicts">example</a> of a conflict arising in a package <code>D</code> used by two other packages, <code>B</code> and <code>C</code>. Our analysis of the error message revealed that <code>B</code> is using an outdated version of <code>D</code>. To fix it, the first thing to try is to <code>pkg&gt; dev B</code> so that you can modify <code>B</code> and its compatibility requirements. If you open its <code>Project.toml</code> file in an editor, you would probably notice something like</p><pre><code class="language-toml hljs">[compat]
D = &quot;0.1&quot;</code></pre><p>Usually the first step is to modify this to something like</p><pre><code class="language-toml hljs">[compat]
D = &quot;0.1, 0.2&quot;</code></pre><p>This indicates that <code>B</code> is compatible with both versions 0.1 and version 0.2; if you <code>pkg&gt; up</code> this would fix the package error. However, there is one major concern you need to address first: perhaps there was an incompatible change in <code>v0.2</code> of <code>D</code> that breaks <code>B</code>. Before proceeding further, you should update all packages and then run <code>B</code>&#39;s tests, scanning the output of <code>pkg&gt; test B</code> to be sure that <code>v0.2</code> of <code>D</code> is in fact being used. (It is possible that an additional dependency of <code>D</code> pins it to <code>v0.1</code>, and you wouldn&#39;t want to be misled into thinking that you had tested <code>B</code> on the newer version.) If the new version was used and the tests still pass, you can assume that <code>B</code> didn&#39;t need any further updating to accommodate <code>v0.2</code> of <code>D</code>; you can safely submit this change as a pull request to <code>B</code> so that a new release is made. If instead an error is thrown, it indicates that <code>B</code> requires more extensive updates to be compatible with the latest version of <code>D</code>; those updates will need to be completed before it becomes possible to use both <code>A</code> and <code>B</code> simultaneously. You can, though, continue to use them independently of one another.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../creating-packages/">« <strong>5.</strong> Creating Packages</a><a class="docs-footer-nextpage" href="../registries/"><strong>7.</strong> Registries »</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="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.25 on <span class="colophon-date" title="Tuesday 8 August 2023 18:50">Tuesday 8 August 2023</span>. Using Julia version 1.11.0-DEV.240.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
D = &quot;0.1, 0.2&quot;</code></pre><p>This indicates that <code>B</code> is compatible with both versions 0.1 and version 0.2; if you <code>pkg&gt; up</code> this would fix the package error. However, there is one major concern you need to address first: perhaps there was an incompatible change in <code>v0.2</code> of <code>D</code> that breaks <code>B</code>. Before proceeding further, you should update all packages and then run <code>B</code>&#39;s tests, scanning the output of <code>pkg&gt; test B</code> to be sure that <code>v0.2</code> of <code>D</code> is in fact being used. (It is possible that an additional dependency of <code>D</code> pins it to <code>v0.1</code>, and you wouldn&#39;t want to be misled into thinking that you had tested <code>B</code> on the newer version.) If the new version was used and the tests still pass, you can assume that <code>B</code> didn&#39;t need any further updating to accommodate <code>v0.2</code> of <code>D</code>; you can safely submit this change as a pull request to <code>B</code> so that a new release is made. If instead an error is thrown, it indicates that <code>B</code> requires more extensive updates to be compatible with the latest version of <code>D</code>; those updates will need to be completed before it becomes possible to use both <code>A</code> and <code>B</code> simultaneously. You can, though, continue to use them independently of one another.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../creating-packages/">« <strong>5.</strong> Creating Packages</a><a class="docs-footer-nextpage" href="../registries/"><strong>7.</strong> Registries »</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="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.25 on <span class="colophon-date" title="Tuesday 8 August 2023 22:38">Tuesday 8 August 2023</span>. Using Julia version 1.11.0-DEV.241.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit bfbe33b

Please sign in to comment.