build based on f0cf5a8

previews/PR2597/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-04T08:44:32","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-04T08:56:27","documenter_version":"1.7.0"}}

previews/PR2597/checklists/index.html

@@ -23,4 +23,4 @@
 
    Either of those should automatically publish a new version to the Julia registry.
  - Once registered, the `TagBot.yml` workflow should create a tag, and rebuild the documentation for this tag.
- - These steps can take quite a bit of time (1 hour or more), so don&#39;t be surprised if the new documentation takes a while to appear.</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../lib/internals/anchors/">Anchors »</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.7.0 on <span class="colophon-date" title="Monday 4 November 2024 08:44">Monday 4 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ - These steps can take quite a bit of time (1 hour or more), so don&#39;t be surprised if the new documentation takes a while to appear.</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../lib/internals/anchors/">Anchors »</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.7.0 on <span class="colophon-date" title="Monday 4 November 2024 08:56">Monday 4 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR2597/lib/internals/docchecks/index.html

@@ -4,6 +4,6 @@
   gtag('js', new Date());
   gtag('config', 'UA-136089579-2', {'page_path': location.pathname + location.search + location.hash});
 </script><script data-outdated-warner src="../../../assets/warner.js"></script><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../../../search_index.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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><link href="../../../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../../"><img class="docs-light-only" src="../../../assets/logo.svg" alt="Documenter.jl logo"/><img class="docs-dark-only" src="../../../assets/logo-dark.svg" alt="Documenter.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../../">Documenter.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../../">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../../../man/guide/">Guide</a></li><li><a class="tocitem" href="../../../man/examples/">Examples</a></li><li><a class="tocitem" href="../../../man/syntax/">Syntax</a></li><li><a class="tocitem" href="../../../man/doctests/">Doctests</a></li><li><a class="tocitem" href="../../../man/latex/"><span>$\LaTeX$</span> Syntax</a></li><li><a class="tocitem" href="../../../man/hosting/">Hosting Documentation</a></li><li><a class="tocitem" href="../../../man/other-formats/">Other Output Formats</a></li></ul></li><li><a class="tocitem" href="../../../showcase/">Showcase</a></li><li><span class="tocitem">Reference</span><ul><li><a class="tocitem" href="../../public/">Public API</a></li><li><a class="tocitem" href="../../remote-links/">Remote repository links</a></li><li><a class="tocitem" href="../../semver/">Semantic versioning</a></li></ul></li><li><span class="tocitem">Developers</span><ul><li><a class="tocitem" href="../../../contributing/">Contributing</a></li><li><a class="tocitem" href="../../../checklists/">Checklists</a></li><li><input class="collapse-toggle" id="menuitem-5-3" type="checkbox" checked/><label class="tocitem" for="menuitem-5-3"><span class="docs-label">Internals</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../anchors/">Anchors</a></li><li><a class="tocitem" href="../builder/">Builder</a></li><li><a class="tocitem" href="../crossref/">Crossrefs</a></li><li><a class="tocitem" href="../deploydocs/">Deploydocs</a></li><li class="is-active"><a class="tocitem" href>DocChecks</a></li><li><a class="tocitem" href="../docmeta/">DocMeta</a></li><li><a class="tocitem" href="../docsystem/">DocSystem</a></li><li><a class="tocitem" href="../doctests/">DocTests</a></li><li><a class="tocitem" href="../documentertools/">DocumenterTools</a></li><li><a class="tocitem" href="../documents/">Documents</a></li><li><a class="tocitem" href="../dom/">DOM</a></li><li><a class="tocitem" href="../expanders/">Expanders</a></li><li><a class="tocitem" href="../jsdependencies/">JSDependencies</a></li><li><a class="tocitem" href="../mdflatten/">MDFlatten</a></li><li><a class="tocitem" href="../selectors/">Selectors</a></li><li><a class="tocitem" href="../textdiff/">TextDiff</a></li><li><a class="tocitem" href="../utilities/">Utilities</a></li><li><a class="tocitem" href="../writers/">Writers</a></li></ul></li></ul></li><li><a class="tocitem" href="../../../release-notes/">Release notes</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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Developers</a></li><li><a class="is-disabled">Internals</a></li><li class="is-active"><a href>DocChecks</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>DocChecks</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaDocs/Documenter.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaDocs/Documenter.jl/blob/master/docs/src/lib/internals/docchecks.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="DocChecks"><a class="docs-heading-anchor" href="#DocChecks">DocChecks</a><a id="DocChecks-1"></a><a class="docs-heading-anchor-permalink" href="#DocChecks" title="Permalink"></a></h1><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="Documenter.footnotes-Tuple{Documenter.Document}" href="#Documenter.footnotes-Tuple{Documenter.Document}"><code>Documenter.footnotes</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">footnotes(doc)
-</code></pre><p>Checks footnote links in a <a href="../documents/#Documenter.Document"><code>Document</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDocs/Documenter.jl/blob/9025b4967694654bf24e16f3b3fa9e1518919a0d/src/docchecks.jl#L110">source</a></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="Documenter.linkcheck-Tuple{Documenter.Document}" href="#Documenter.linkcheck-Tuple{Documenter.Document}"><code>Documenter.linkcheck</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">linkcheck(doc)
-</code></pre><p>Checks external links using curl.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDocs/Documenter.jl/blob/9025b4967694654bf24e16f3b3fa9e1518919a0d/src/docchecks.jl#L172">source</a></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="Documenter.missingdocs-Tuple{Documenter.Document}" href="#Documenter.missingdocs-Tuple{Documenter.Document}"><code>Documenter.missingdocs</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">missingdocs(doc)
-</code></pre><p>Checks that a <a href="../documents/#Documenter.Document"><code>Document</code></a> contains all available docstrings that are defined in the <code>modules</code> keyword passed to <a href="../../public/#Documenter.makedocs"><code>makedocs</code></a>.</p><p>Prints out the name of each object that has not had its docs spliced into the document.</p><p>Returns the number of missing bindings to allow for automated testing of documentation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDocs/Documenter.jl/blob/9025b4967694654bf24e16f3b3fa9e1518919a0d/src/docchecks.jl#L7">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../deploydocs/">« Deploydocs</a><a class="docs-footer-nextpage" href="../docmeta/">DocMeta »</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.7.0 on <span class="colophon-date" title="Monday 4 November 2024 08:44">Monday 4 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><div data-docstringscollapsed="true"></div></html>
+</code></pre><p>Checks footnote links in a <a href="../documents/#Documenter.Document"><code>Document</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDocs/Documenter.jl/blob/f0cf5a8022cbe533d595e9b311876d95f36152dd/src/docchecks.jl#L110">source</a></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="Documenter.linkcheck-Tuple{Documenter.Document}" href="#Documenter.linkcheck-Tuple{Documenter.Document}"><code>Documenter.linkcheck</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">linkcheck(doc)
+</code></pre><p>Checks external links using curl.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDocs/Documenter.jl/blob/f0cf5a8022cbe533d595e9b311876d95f36152dd/src/docchecks.jl#L172">source</a></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="Documenter.missingdocs-Tuple{Documenter.Document}" href="#Documenter.missingdocs-Tuple{Documenter.Document}"><code>Documenter.missingdocs</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">missingdocs(doc)
+</code></pre><p>Checks that a <a href="../documents/#Documenter.Document"><code>Document</code></a> contains all available docstrings that are defined in the <code>modules</code> keyword passed to <a href="../../public/#Documenter.makedocs"><code>makedocs</code></a>.</p><p>Prints out the name of each object that has not had its docs spliced into the document.</p><p>Returns the number of missing bindings to allow for automated testing of documentation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDocs/Documenter.jl/blob/f0cf5a8022cbe533d595e9b311876d95f36152dd/src/docchecks.jl#L7">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../deploydocs/">« Deploydocs</a><a class="docs-footer-nextpage" href="../docmeta/">DocMeta »</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.7.0 on <span class="colophon-date" title="Monday 4 November 2024 08:56">Monday 4 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><div data-docstringscollapsed="true"></div></html>