build based on 974d356

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-01-25T21:13:50","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.3","generation_timestamp":"2025-01-30T04:12:36","documenter_version":"1.8.0"}}

dev/index.html

@@ -21,4 +21,4 @@
 ```julia
 using LocalRegistry: LocalRegistry
 LocalRegistry.register()
-```</code></pre><p>Examples go here.</p><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">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 25 January 2025 21:13">Saturday 25 January 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+```</code></pre><p>Examples go here.</p><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">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 30 January 2025 04:12">Thursday 30 January 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/reference/index.html

@@ -26,4 +26,4 @@
 
 julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), downstreampkgs=["ITensors", "ITensorMPS"]);
 
-julia&gt; ITensorPkgSkeleton.generate(&quot;NewPkg&quot;; path=mktempdir(), downstreampkgs=[(user=&quot;ITensor&quot;, repo=&quot;ITensors&quot;)]);</code></pre><p><strong>Arguments</strong></p><ul><li><code>pkgname::AbstractString</code>: Name of the package (without the <code>.jl</code> extension). Replaces <code>{PKGNAME}</code> in the template.</li></ul><p><strong>Keywords</strong></p><ul><li><code>path::AbstractString</code>: Path where the package will be generated. Defaults to the <a href="https://pkgdocs.julialang.org/v1/api/#Pkg.develop">development directory</a>, i.e. <code>/home/runner/.julia/dev</code>.</li><li><code>templates</code>: A list of templates to use. Select a subset of <code>ITensorPkgSkeleton.all_templates() = [&quot;benchmark&quot;, &quot;docs&quot;, &quot;downstreampkgs&quot;, &quot;examples&quot;, &quot;formatter&quot;, &quot;github&quot;, &quot;gitignore&quot;, &quot;license&quot;, &quot;precommit&quot;, &quot;project&quot;, &quot;src&quot;, &quot;test&quot;]</code>. Defaults to <code>ITensorPkgSkeleton.default_templates() = [&quot;benchmark&quot;, &quot;docs&quot;, &quot;downstreampkgs&quot;, &quot;examples&quot;, &quot;formatter&quot;, &quot;github&quot;, &quot;gitignore&quot;, &quot;license&quot;, &quot;precommit&quot;, &quot;project&quot;, &quot;src&quot;, &quot;test&quot;]</code>.</li><li><code>ignore_templates</code>: A list of templates to ignore. This is the same as setting <code>templates=setdiff(templates, ignore_templates)</code>.</li><li><code>downstreampkgs</code>: Specify the downstream packages that depend on this package. Setting this will create a workflow where the downstream tests will be run alongside the tests for this package in Github Actions to ensure that changes to your package don&#39;t break the specified downstream packages. Specify it as a list of packages, for example <code>[&quot;DownstreamPkg1&quot;, &quot;DownstreamPkg2&quot;]</code>, which assumes the packages are in the <code>ITensor</code> organization. Alternatively, specify the organization with <code>[(user=&quot;Org1&quot;, repo=&quot;DownstreamPkg1&quot;), (user=&quot;Org2&quot;, repo=&quot;DownstreamPkg2&quot;)]</code>; . Defaults to an empty list.</li><li><code>uuid</code>: Replaces <code>{UUID}</code> in the template. Defaults to the existing UUID in the <code>Project.toml</code> if the path points to an existing package, otherwise generates one randomly with <code>UUIDs.uuid4()</code>.</li><li><code>year</code>: Replaces <code>{YEAR}</code> in the template. Year the package/repository was created. Defaults to the current year.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensorPkgSkeleton.jl/blob/974d356f1d2ea9db1a1e491f5655316603524988/src/ITensorPkgSkeleton.jl#L183">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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 25 January 2025 21:13">Saturday 25 January 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia&gt; ITensorPkgSkeleton.generate(&quot;NewPkg&quot;; path=mktempdir(), downstreampkgs=[(user=&quot;ITensor&quot;, repo=&quot;ITensors&quot;)]);</code></pre><p><strong>Arguments</strong></p><ul><li><code>pkgname::AbstractString</code>: Name of the package (without the <code>.jl</code> extension). Replaces <code>{PKGNAME}</code> in the template.</li></ul><p><strong>Keywords</strong></p><ul><li><code>path::AbstractString</code>: Path where the package will be generated. Defaults to the <a href="https://pkgdocs.julialang.org/v1/api/#Pkg.develop">development directory</a>, i.e. <code>/home/runner/.julia/dev</code>.</li><li><code>templates</code>: A list of templates to use. Select a subset of <code>ITensorPkgSkeleton.all_templates() = [&quot;benchmark&quot;, &quot;docs&quot;, &quot;downstreampkgs&quot;, &quot;examples&quot;, &quot;formatter&quot;, &quot;github&quot;, &quot;gitignore&quot;, &quot;license&quot;, &quot;precommit&quot;, &quot;project&quot;, &quot;src&quot;, &quot;test&quot;]</code>. Defaults to <code>ITensorPkgSkeleton.default_templates() = [&quot;benchmark&quot;, &quot;docs&quot;, &quot;downstreampkgs&quot;, &quot;examples&quot;, &quot;formatter&quot;, &quot;github&quot;, &quot;gitignore&quot;, &quot;license&quot;, &quot;precommit&quot;, &quot;project&quot;, &quot;src&quot;, &quot;test&quot;]</code>.</li><li><code>ignore_templates</code>: A list of templates to ignore. This is the same as setting <code>templates=setdiff(templates, ignore_templates)</code>.</li><li><code>downstreampkgs</code>: Specify the downstream packages that depend on this package. Setting this will create a workflow where the downstream tests will be run alongside the tests for this package in Github Actions to ensure that changes to your package don&#39;t break the specified downstream packages. Specify it as a list of packages, for example <code>[&quot;DownstreamPkg1&quot;, &quot;DownstreamPkg2&quot;]</code>, which assumes the packages are in the <code>ITensor</code> organization. Alternatively, specify the organization with <code>[(user=&quot;Org1&quot;, repo=&quot;DownstreamPkg1&quot;), (user=&quot;Org2&quot;, repo=&quot;DownstreamPkg2&quot;)]</code>; . Defaults to an empty list.</li><li><code>uuid</code>: Replaces <code>{UUID}</code> in the template. Defaults to the existing UUID in the <code>Project.toml</code> if the path points to an existing package, otherwise generates one randomly with <code>UUIDs.uuid4()</code>.</li><li><code>year</code>: Replaces <code>{YEAR}</code> in the template. Year the package/repository was created. Defaults to the current year.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ITensor/ITensorPkgSkeleton.jl/blob/974d356f1d2ea9db1a1e491f5655316603524988/src/ITensorPkgSkeleton.jl#L183">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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 30 January 2025 04:12">Thursday 30 January 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>