build based on d90f108

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-01-01T08:25:55","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-01-03T08:23:00","documenter_version":"1.2.1"}}

dev/contributing/new-example/index.html

@@ -4,4 +4,4 @@
 \end{aligned}$$</code></pre><ol><li>When using equations, make sure not to follow the left-hand <code>$$</code> or <code>$</code> with a space, but instead directly start the equation, e.g. not <code>$$ a + b $$</code>, but <code>$$a + b$$</code>. For equations that are supposed to be on a separate line, make sure <code>$$...$$</code> is preceded and followed by an empty line.</li><li>Notebooks and plain Julia have different scoping rules for global variables. It may happen that the generation of your example fails due to an <code>UndefVarError</code> or other scoping issues. In these cases we recommend using <code>let ... end</code> blocks to enforce local scoping or use the <code>global</code> keyword to disambiguate the scoping rules, e.g.</li></ol><pre><code class="language-julia hljs">variable = 0
 for i in 1:10
     global variable = variable + i
-end</code></pre><ol><li>All examples must use and activate the local environment specified by <code>Project.toml</code> in the second cell (see <code>1.</code>). Please have a look at the existing notebooks for an example on how to activate this local environment. If you need additional packages, you can add then to the <code>(examples)</code> project.</li><li>All plots should be displayed automatically. In special cases, if needed, save figures in the <code>../pics/figure-name.ext</code> format. Might be useful for saving gifs. Use <code>![](../pics/figure-name.ext)</code> to display a static image.</li></ol><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Please avoid adding <code>PyPlot</code> in the <code>(examples)</code> project. Installing and building <code>PyPlot</code> dependencies takes several minutes on every CI run. Use <code>Plots</code> instead.</p></div></div><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Use <code>make examples</code> to run all examples or <code>make examples specific=MyNewCoolNotebook</code> to run any notebook that includes <code>MyNewCoolNotebook</code> in its file name.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../new-package/">« Contributing to the dependencies</a><a class="docs-footer-nextpage" href="../new-release/">Publishing a new release »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Monday 1 January 2024 08:25">Monday 1 January 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><ol><li>All examples must use and activate the local environment specified by <code>Project.toml</code> in the second cell (see <code>1.</code>). Please have a look at the existing notebooks for an example on how to activate this local environment. If you need additional packages, you can add then to the <code>(examples)</code> project.</li><li>All plots should be displayed automatically. In special cases, if needed, save figures in the <code>../pics/figure-name.ext</code> format. Might be useful for saving gifs. Use <code>![](../pics/figure-name.ext)</code> to display a static image.</li></ol><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Please avoid adding <code>PyPlot</code> in the <code>(examples)</code> project. Installing and building <code>PyPlot</code> dependencies takes several minutes on every CI run. Use <code>Plots</code> instead.</p></div></div><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Use <code>make examples</code> to run all examples or <code>make examples specific=MyNewCoolNotebook</code> to run any notebook that includes <code>MyNewCoolNotebook</code> in its file name.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../new-package/">« Contributing to the dependencies</a><a class="docs-footer-nextpage" href="../new-release/">Publishing a new release »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Wednesday 3 January 2024 08:23">Wednesday 3 January 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/contributing/new-package/index.html

@@ -25,4 +25,4 @@
 julia = &quot;1.9.2&quot;</code></pre><p>Try to be conservative and set as low version of Julia as possible.</p><ul><li><h4>Adjust the authors of the package</h4></li></ul><p>The authors field is present in the <code>Project.toml</code>, e.g </p><pre><code class="language-toml hljs">authors = [&quot;John Wick &lt;[email protected]&gt;&quot;, ...]</code></pre><ul><li><h4>Add requires dependencies and their <code>[compat]</code> bounds</h4></li></ul><p>To add new dependencies to your newly created package, start Julia in the package&#39;s folder and activate the project using one of the following methods:</p><pre><code class="language-bash hljs">julia --project=.</code></pre><p>or </p><pre><code class="language-bash hljs">julia</code></pre><pre><code class="language-julia hljs">julia&gt; ] activate .</code></pre><p>Then, add dependencies like this:</p><pre><code class="language-julia hljs">julia&gt; ] add SomeCoolDependency, SomeOtherCoolDependency</code></pre><p>For each new dependency, it&#39;s essential to specify the minimum compatible version in the <code>[compat]</code>section of the <code>Project.toml</code> file, otherwise the official Julia registry will not register your new package. Add the <code>[compat]</code> entries like this:</p><pre><code class="language-toml hljs">[compat]
 julia = &quot;1.9&quot;
 SomeCoolDependency = &quot;0.19.2&quot;
-SomeOtherCoolDependency = &quot;1.3.12&quot;</code></pre><p>For more details on <code>compat</code> bounds, check the official Julia documentation.</p><h2 id="Adjust-README.md"><a class="docs-heading-anchor" href="#Adjust-README.md">Adjust <code>README.md</code></a><a id="Adjust-README.md-1"></a><a class="docs-heading-anchor-permalink" href="#Adjust-README.md" title="Permalink"></a></h2><p>The <code>README.md</code> file is the front door to your project, offering a concise introduction and guidance for users and contributors. It&#39;s a critical piece of documentation that sets the tone for your project&#39;s accessibility and success. A well-crafted <code>README.md</code> provides essential information, such as installation instructions, usage examples, and project goals, making it easier for others to understand, engage with, and contribute to your work. So, remember, taking the time to write a clear and informative <code>README.md</code>.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Some badges in the auto-generated <code>README.md</code> will be broken unless you register your package in the official Julia registry.</p></div></div><h2 id="Write-code-and-tests"><a class="docs-heading-anchor" href="#Write-code-and-tests">Write code and tests</a><a id="Write-code-and-tests-1"></a><a class="docs-heading-anchor-permalink" href="#Write-code-and-tests" title="Permalink"></a></h2><p>The provided template generates a package with testing and test coverage enabled. Ensure to test all new functionality in the <code>test/runtests.jl</code> file.</p><h3 id="Simplify-Testing-with-ReTestItems"><a class="docs-heading-anchor" href="#Simplify-Testing-with-ReTestItems">Simplify Testing with <code>ReTestItems</code></a><a id="Simplify-Testing-with-ReTestItems-1"></a><a class="docs-heading-anchor-permalink" href="#Simplify-Testing-with-ReTestItems" title="Permalink"></a></h3><p>You can streamline testing by using the <code>ReTestItems</code> package, which support VSCode UI for running tests. Refer to the <code>ReTestItems</code> documentation for more information.</p><h2 id="Write-code-and-the-documentation"><a class="docs-heading-anchor" href="#Write-code-and-the-documentation">Write code and the documentation</a><a id="Write-code-and-the-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Write-code-and-the-documentation" title="Permalink"></a></h2><p>Julia, adding documentation is straightforward with the <code>Documenter.jl</code> package. Add docstrings to newly created functions and update the <code>docs/index.md</code>  ` file.  To build the documentation locally, use this command (ensure you initialize and instantiate the docs environment first):</p><pre><code class="language-bash hljs">julia --project=docs docs/make.jl</code></pre><p>For customization, refer to the <code>Documenter.jl</code> documentation. Also, check out the <a href="../new-documentation/#guide-docs-contributing">contributing guide</a>.</p><h3 id="Hosting-Documentation-with-GitHub-Actions"><a class="docs-heading-anchor" href="#Hosting-Documentation-with-GitHub-Actions">Hosting Documentation with GitHub Actions</a><a id="Hosting-Documentation-with-GitHub-Actions-1"></a><a class="docs-heading-anchor-permalink" href="#Hosting-Documentation-with-GitHub-Actions" title="Permalink"></a></h3><p>The template provided generates a package with automatic documentation hosting through GitHub Actions. To make this process work, you&#39;ll need to generate a <code>DOCUMENTER_KEY</code> using <code>DocumenterTools.jl</code> and add it to your package&#39;s repository settings. You can find detailed instructions on how to do this <a href="https://documenter.juliadocs.org/stable/man/hosting/#travis-ssh">here</a>.</p><h3 id="Enable-GitHub-Pages-in-Repository-Settings"><a class="docs-heading-anchor" href="#Enable-GitHub-Pages-in-Repository-Settings">Enable GitHub Pages in Repository Settings</a><a id="Enable-GitHub-Pages-in-Repository-Settings-1"></a><a class="docs-heading-anchor-permalink" href="#Enable-GitHub-Pages-in-Repository-Settings" title="Permalink"></a></h3><p>The final step for setting up documentation hosting is to enable GitHub Pages in your package&#39;s repository settings. To do this:</p><ol><li>Navigate to the GitHub Pages settings of your repository.</li><li>Choose the <strong>Deploy from a branch</strong> option.</li><li>Select the <code>gh-pages</code> branch.</li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../new-documentation/">« Contributing to the documentation</a><a class="docs-footer-nextpage" href="../new-example/">Contributing to the examples »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Monday 1 January 2024 08:25">Monday 1 January 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+SomeOtherCoolDependency = &quot;1.3.12&quot;</code></pre><p>For more details on <code>compat</code> bounds, check the official Julia documentation.</p><h2 id="Adjust-README.md"><a class="docs-heading-anchor" href="#Adjust-README.md">Adjust <code>README.md</code></a><a id="Adjust-README.md-1"></a><a class="docs-heading-anchor-permalink" href="#Adjust-README.md" title="Permalink"></a></h2><p>The <code>README.md</code> file is the front door to your project, offering a concise introduction and guidance for users and contributors. It&#39;s a critical piece of documentation that sets the tone for your project&#39;s accessibility and success. A well-crafted <code>README.md</code> provides essential information, such as installation instructions, usage examples, and project goals, making it easier for others to understand, engage with, and contribute to your work. So, remember, taking the time to write a clear and informative <code>README.md</code>.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Some badges in the auto-generated <code>README.md</code> will be broken unless you register your package in the official Julia registry.</p></div></div><h2 id="Write-code-and-tests"><a class="docs-heading-anchor" href="#Write-code-and-tests">Write code and tests</a><a id="Write-code-and-tests-1"></a><a class="docs-heading-anchor-permalink" href="#Write-code-and-tests" title="Permalink"></a></h2><p>The provided template generates a package with testing and test coverage enabled. Ensure to test all new functionality in the <code>test/runtests.jl</code> file.</p><h3 id="Simplify-Testing-with-ReTestItems"><a class="docs-heading-anchor" href="#Simplify-Testing-with-ReTestItems">Simplify Testing with <code>ReTestItems</code></a><a id="Simplify-Testing-with-ReTestItems-1"></a><a class="docs-heading-anchor-permalink" href="#Simplify-Testing-with-ReTestItems" title="Permalink"></a></h3><p>You can streamline testing by using the <code>ReTestItems</code> package, which support VSCode UI for running tests. Refer to the <code>ReTestItems</code> documentation for more information.</p><h2 id="Write-code-and-the-documentation"><a class="docs-heading-anchor" href="#Write-code-and-the-documentation">Write code and the documentation</a><a id="Write-code-and-the-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Write-code-and-the-documentation" title="Permalink"></a></h2><p>Julia, adding documentation is straightforward with the <code>Documenter.jl</code> package. Add docstrings to newly created functions and update the <code>docs/index.md</code>  ` file.  To build the documentation locally, use this command (ensure you initialize and instantiate the docs environment first):</p><pre><code class="language-bash hljs">julia --project=docs docs/make.jl</code></pre><p>For customization, refer to the <code>Documenter.jl</code> documentation. Also, check out the <a href="../new-documentation/#guide-docs-contributing">contributing guide</a>.</p><h3 id="Hosting-Documentation-with-GitHub-Actions"><a class="docs-heading-anchor" href="#Hosting-Documentation-with-GitHub-Actions">Hosting Documentation with GitHub Actions</a><a id="Hosting-Documentation-with-GitHub-Actions-1"></a><a class="docs-heading-anchor-permalink" href="#Hosting-Documentation-with-GitHub-Actions" title="Permalink"></a></h3><p>The template provided generates a package with automatic documentation hosting through GitHub Actions. To make this process work, you&#39;ll need to generate a <code>DOCUMENTER_KEY</code> using <code>DocumenterTools.jl</code> and add it to your package&#39;s repository settings. You can find detailed instructions on how to do this <a href="https://documenter.juliadocs.org/stable/man/hosting/#travis-ssh">here</a>.</p><h3 id="Enable-GitHub-Pages-in-Repository-Settings"><a class="docs-heading-anchor" href="#Enable-GitHub-Pages-in-Repository-Settings">Enable GitHub Pages in Repository Settings</a><a id="Enable-GitHub-Pages-in-Repository-Settings-1"></a><a class="docs-heading-anchor-permalink" href="#Enable-GitHub-Pages-in-Repository-Settings" title="Permalink"></a></h3><p>The final step for setting up documentation hosting is to enable GitHub Pages in your package&#39;s repository settings. To do this:</p><ol><li>Navigate to the GitHub Pages settings of your repository.</li><li>Choose the <strong>Deploy from a branch</strong> option.</li><li>Select the <code>gh-pages</code> branch.</li></ol></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../new-documentation/">« Contributing to the documentation</a><a class="docs-footer-nextpage" href="../new-example/">Contributing to the examples »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Wednesday 3 January 2024 08:22">Wednesday 3 January 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>