build based on 7dd3a41

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-28T17:23:35","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-28T17:28:10","documenter_version":"1.2.1"}}

dev/creating/index.html

@@ -31,4 +31,4 @@
 [[std.doc]]
 dispname = "Python (programming language)"
 name = "Python"
-uri = &quot;Python_(programming_language)&quot;</code></pre><p>The requirements for the file are in the description of the <a href="../formats/#TOML-Format">TOML Format</a>, but should be fairly intuitive.</p><p>In general, custom inventory files should be stored as an uncompressed <code>.toml</code> file. This makes them much easier to maintain with a text editor. In addition, these inventories will presumably be checked into a <code>git</code> repository, which will be much more efficient with uncompressed (diffable!) text-based files.</p><p>In contrast, inventories that are <em>deployed</em> (put online so that other projects may download them to resolve links) should always be compressed, either as an <a href="../formats/#Sphinx-Inventory-Format"><code>objects.inv</code> file</a> or as an <a href="../formats/#TOML-Format"><code>inventory.toml.gz</code> file</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../formats/">« Inventory File Formats</a><a class="docs-footer-nextpage" href="../api/">API »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/goerz/DocInventories.jl">DocInventories.jl</a> v0.3.0+dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</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="Sunday 28 January 2024 17:23">Sunday 28 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+uri = &quot;Python_(programming_language)&quot;</code></pre><p>The requirements for the file are in the description of the <a href="../formats/#TOML-Format">TOML Format</a>, but should be fairly intuitive.</p><p>In general, custom inventory files should be stored as an uncompressed <code>.toml</code> file. This makes them much easier to maintain with a text editor. In addition, these inventories will presumably be checked into a <code>git</code> repository, which will be much more efficient with uncompressed (diffable!) text-based files.</p><p>In contrast, inventories that are <em>deployed</em> (put online so that other projects may download them to resolve links) should always be compressed, either as an <a href="../formats/#Sphinx-Inventory-Format"><code>objects.inv</code> file</a> or as an <a href="../formats/#TOML-Format"><code>inventory.toml.gz</code> file</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../formats/">« Inventory File Formats</a><a class="docs-footer-nextpage" href="../api/">API »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/goerz/DocInventories.jl">DocInventories.jl</a> v0.3.1 docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</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="Sunday 28 January 2024 17:28">Sunday 28 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/formats/index.html

@@ -8,4 +8,4 @@
 name = "<name>"
 uri = "<uri>"
 dispname = "<dispname>"
-priority = &lt;priority&gt;</code></pre><p>The four lines for <code>name</code>, <code>uri</code>, <code>dispname</code>, and <code>priority</code> may occur in any order. Also, for items with the default priority (<code>-1</code> for the <code>std</code> domain, <code>1</code> otherwise), the <code>priority</code> line may be omitted. If <code>dispname</code> is equal to <code>name</code> (usually indicated by <code>dispname=&quot;-&quot;</code>), the <code>dispname</code> line may also be omitted.</p><p>The item-blocks may be grouped/separated by blank lines. In <code>.toml</code> files generated by <code>DocInventories.save(&quot;inventory.toml&quot;, inventory)</code> items will be grouped into blocks with the same <code>[[&lt;domain&gt;.&lt;role&gt;]]</code> with a blank line between each block.</p><p>Any TOML parser should read a <code>.toml</code> file with the above structure into a nested dictionary, so that <code>item_dict = toml_data[domain][role][i]</code> corresponds to the <code>i</code>&#39;th inventory item with the given <code>domain</code> and <code>role</code>. That <code>item_dict</code> will then map <code>&quot;name&quot;</code>, <code>&quot;uri&quot;</code>, and potentially <code>&quot;dispname&quot;</code> and <code>&quot;priority&quot;</code> to their respective values.</p><p>A compressed TOML file can be written with, e.g., <code>DocInventories.save(&quot;inventory.toml.gz&quot;, inventory)</code>. With compression, the size of the file should be comparable (albeit slightly larger) than the compressed <code>objects.inv</code> format.</p><h2 id="Size-Comparison"><a class="docs-heading-anchor" href="#Size-Comparison">Size Comparison</a><a id="Size-Comparison-1"></a><a class="docs-heading-anchor-permalink" href="#Size-Comparison" title="Permalink"></a></h2><p>In the following table, we compare the size of the inventory file of different projects in kilobytes, for the various output formats.</p><table><tr><th style="text-align: right"><strong>Project</strong></th><th style="text-align: right"><strong>No. of Objects</strong></th><th style="text-align: right"><strong>.txt</strong></th><th style="text-align: right"><strong>.toml</strong></th><th style="text-align: right"><strong>.inv</strong></th><th style="text-align: right"><strong>.toml.gz</strong></th></tr><tr><td style="text-align: right">Documenter</td><td style="text-align: right">483</td><td style="text-align: right">53.1 kB</td><td style="text-align: right">64.1 kB</td><td style="text-align: right">8.3 kB</td><td style="text-align: right">8.5 kB</td></tr><tr><td style="text-align: right">Julia</td><td style="text-align: right">3602</td><td style="text-align: right">250.0 kB</td><td style="text-align: right">324.6 kB</td><td style="text-align: right">45.0 kB</td><td style="text-align: right">45.9 kB</td></tr><tr><td style="text-align: right">Matplotlib</td><td style="text-align: right">10406</td><td style="text-align: right">1110.3 kB</td><td style="text-align: right">1323.3 kB</td><td style="text-align: right">105.9 kB</td><td style="text-align: right">110.8 kB</td></tr><tr><td style="text-align: right">Python</td><td style="text-align: right">16449</td><td style="text-align: right">1083.4 kB</td><td style="text-align: right">1396.7 kB</td><td style="text-align: right">140.6 kB</td><td style="text-align: right">146.7 kB</td></tr></table></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../creating/">Creating Inventory Files »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/goerz/DocInventories.jl">DocInventories.jl</a> v0.3.0+dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</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="Sunday 28 January 2024 17:23">Sunday 28 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+priority = &lt;priority&gt;</code></pre><p>The four lines for <code>name</code>, <code>uri</code>, <code>dispname</code>, and <code>priority</code> may occur in any order. Also, for items with the default priority (<code>-1</code> for the <code>std</code> domain, <code>1</code> otherwise), the <code>priority</code> line may be omitted. If <code>dispname</code> is equal to <code>name</code> (usually indicated by <code>dispname=&quot;-&quot;</code>), the <code>dispname</code> line may also be omitted.</p><p>The item-blocks may be grouped/separated by blank lines. In <code>.toml</code> files generated by <code>DocInventories.save(&quot;inventory.toml&quot;, inventory)</code> items will be grouped into blocks with the same <code>[[&lt;domain&gt;.&lt;role&gt;]]</code> with a blank line between each block.</p><p>Any TOML parser should read a <code>.toml</code> file with the above structure into a nested dictionary, so that <code>item_dict = toml_data[domain][role][i]</code> corresponds to the <code>i</code>&#39;th inventory item with the given <code>domain</code> and <code>role</code>. That <code>item_dict</code> will then map <code>&quot;name&quot;</code>, <code>&quot;uri&quot;</code>, and potentially <code>&quot;dispname&quot;</code> and <code>&quot;priority&quot;</code> to their respective values.</p><p>A compressed TOML file can be written with, e.g., <code>DocInventories.save(&quot;inventory.toml.gz&quot;, inventory)</code>. With compression, the size of the file should be comparable (albeit slightly larger) than the compressed <code>objects.inv</code> format.</p><h2 id="Size-Comparison"><a class="docs-heading-anchor" href="#Size-Comparison">Size Comparison</a><a id="Size-Comparison-1"></a><a class="docs-heading-anchor-permalink" href="#Size-Comparison" title="Permalink"></a></h2><p>In the following table, we compare the size of the inventory file of different projects in kilobytes, for the various output formats.</p><table><tr><th style="text-align: right"><strong>Project</strong></th><th style="text-align: right"><strong>No. of Objects</strong></th><th style="text-align: right"><strong>.txt</strong></th><th style="text-align: right"><strong>.toml</strong></th><th style="text-align: right"><strong>.inv</strong></th><th style="text-align: right"><strong>.toml.gz</strong></th></tr><tr><td style="text-align: right">Documenter</td><td style="text-align: right">483</td><td style="text-align: right">53.1 kB</td><td style="text-align: right">64.1 kB</td><td style="text-align: right">8.3 kB</td><td style="text-align: right">8.5 kB</td></tr><tr><td style="text-align: right">Julia</td><td style="text-align: right">3602</td><td style="text-align: right">250.0 kB</td><td style="text-align: right">324.6 kB</td><td style="text-align: right">45.0 kB</td><td style="text-align: right">45.9 kB</td></tr><tr><td style="text-align: right">Matplotlib</td><td style="text-align: right">10406</td><td style="text-align: right">1110.3 kB</td><td style="text-align: right">1323.3 kB</td><td style="text-align: right">105.9 kB</td><td style="text-align: right">110.8 kB</td></tr><tr><td style="text-align: right">Python</td><td style="text-align: right">16449</td><td style="text-align: right">1083.4 kB</td><td style="text-align: right">1396.7 kB</td><td style="text-align: right">140.6 kB</td><td style="text-align: right">146.7 kB</td></tr></table></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../creating/">Creating Inventory Files »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/goerz/DocInventories.jl">DocInventories.jl</a> v0.3.1 docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</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="Sunday 28 January 2024 17:28">Sunday 28 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>