Skip to content

Commit 7a78399

Browse files
zeptodoctorDocumenter.jl
zeptodoctor
authored and
Documenter.jl
committed
build based on b72c565
0 parents  commit 7a78399

File tree

117 files changed

+70133
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+70133
-0
lines changed

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-19T13:41:27","documenter_version":"1.3.0"}}

dev/LICENSE/index.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>LICENSE · PropDicts</title><meta name="title" content="LICENSE · PropDicts"/><meta property="og:title" content="LICENSE · PropDicts"/><meta property="twitter:title" content="LICENSE · PropDicts"/><meta name="description" content="Documentation for PropDicts."/><meta property="og:description" content="Documentation for PropDicts."/><meta property="twitter:description" content="Documentation for PropDicts."/><meta property="og:url" content="https://oschulz.github.io/PropDicts.jl/stable/LICENSE/"/><meta property="twitter:url" content="https://oschulz.github.io/PropDicts.jl/stable/LICENSE/"/><link rel="canonical" href="https://oschulz.github.io/PropDicts.jl/stable/LICENSE/"/><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/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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">PropDicts</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><a class="tocitem" href="../api/">API</a></li><li class="is-active"><a class="tocitem" href>LICENSE</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 class="is-active"><a href>LICENSE</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>LICENSE</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/oschulz/PropDicts.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/oschulz/PropDicts.jl/blob/main/docs/src/LICENSE.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="LICENSE"><a class="docs-heading-anchor" href="#LICENSE">LICENSE</a><a id="LICENSE-1"></a><a class="docs-heading-anchor-permalink" href="#LICENSE" title="Permalink"></a></h1><p>The PropDicts.jl package is licensed under the MIT &quot;Expat&quot; License:</p><blockquote><p>Copyright (c) 2017:</p><p>Oliver Schulz &lt;oschulz@mpp.mpg.de&gt;</p><p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p><p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p><p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p></blockquote></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« API</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Tuesday 19 March 2024 13:41">Tuesday 19 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/api/index.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · PropDicts</title><meta name="title" content="API · PropDicts"/><meta property="og:title" content="API · PropDicts"/><meta property="twitter:title" content="API · PropDicts"/><meta name="description" content="Documentation for PropDicts."/><meta property="og:description" content="Documentation for PropDicts."/><meta property="twitter:description" content="Documentation for PropDicts."/><meta property="og:url" content="https://oschulz.github.io/PropDicts.jl/stable/api/"/><meta property="twitter:url" content="https://oschulz.github.io/PropDicts.jl/stable/api/"/><link rel="canonical" href="https://oschulz.github.io/PropDicts.jl/stable/api/"/><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/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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">PropDicts</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 class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#Types"><span>Types</span></a></li><li><a class="tocitem" href="#Functions-and-macros"><span>Functions and macros</span></a></li><li class="toplevel"><a class="tocitem" href="#Documentation"><span>Documentation</span></a></li></ul></li><li><a class="tocitem" href="../LICENSE/">LICENSE</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 class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/oschulz/PropDicts.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/oschulz/PropDicts.jl/blob/main/docs/src/api.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="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><h2 id="Types"><a class="docs-heading-anchor" href="#Types">Types</a><a id="Types-1"></a><a class="docs-heading-anchor-permalink" href="#Types" title="Permalink"></a></h2><ul><li><a href="#PropDicts.MissingProperty"><code>PropDicts.MissingProperty</code></a></li><li><a href="#PropDicts.PropDict"><code>PropDicts.PropDict</code></a></li></ul><h2 id="Functions-and-macros"><a class="docs-heading-anchor" href="#Functions-and-macros">Functions and macros</a><a id="Functions-and-macros-1"></a><a class="docs-heading-anchor-permalink" href="#Functions-and-macros" title="Permalink"></a></h2><ul><li><a href="#PropDicts.readprops"><code>PropDicts.readprops</code></a></li><li><a href="#PropDicts.trim_null!"><code>PropDicts.trim_null!</code></a></li><li><a href="#PropDicts.writeprops"><code>PropDicts.writeprops</code></a></li></ul><h1 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" 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="PropDicts.MissingProperty" href="#PropDicts.MissingProperty"><code>PropDicts.MissingProperty</code></a><span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct MissingProperty</code></pre><p>An instance MissingProperty(parent, key::Symbol) represents the fact the <code>key</code> is missing in <code>parent</code>.</p><p>Instances of <code>MissingProperty</code> support <code>setindex!</code> and <code>setproperty!</code>, this will create the <code>key</code> in <code>parent</code> as a <a href="#PropDicts.PropDict"><code>PropDict</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/oschulz/PropDicts.jl/blob/2cc2071e559599f49eb494ebf160115933b0f43f/src/propdict.jl#L300-L308">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="PropDicts.PropDict" href="#PropDicts.PropDict"><code>PropDicts.PropDict</code></a><span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">PropDict &lt;: AbstractDict{Union{Symbol,Int},Any}</code></pre><p>PropDicts is a dictionary for that supports</p><p>Constructors:</p><pre><code class="nohighlight hljs">PropDict(dict::AbstractDict)
3+
4+
PropDict(key1 =&gt; value, key2 =&gt; value2, ...)</code></pre><p>During construction, keys are automatically converted to <code>Symbol</code>s and <code>Int</code>s, values that are dicts are converted to <code>PropDict</code>s.</p><p><code>PropDict</code> support deep merging:</p><pre><code class="language-julia hljs">x = PropDict(:a =&gt; PropDict(:b =&gt; 7, :c =&gt; 5, :d =&gt; 2), :e =&gt; &quot;foo&quot;)
5+
y = PropDict(:a =&gt; PropDict(:c =&gt; 42, :d =&gt; nothing), :f =&gt; &quot;bar&quot;)
6+
7+
z = merge(x, y)
8+
@assert z == PropDict(
9+
:a =&gt; PropDict(:b=&gt;7, :d =&gt; nothing, :c =&gt; 42),
10+
:e =&gt; &quot;foo&quot;, :f =&gt; &quot;bar&quot;
11+
)
12+
13+
PropDicts.trim_null!(z)
14+
@assert z == PropDict(
15+
:a =&gt; PropDict(:b=&gt;7, :c =&gt; 42),
16+
:e =&gt; &quot;foo&quot;, :f =&gt; &quot;bar&quot;
17+
)</code></pre><p>Acessing non-existing properties will return instances of <a href="#PropDicts.MissingProperty"><code>PropDicts.MissingProperty</code></a>). When setting the value of missing properties, parent <code>PropDict</code>s are created automatically:</p><pre><code class="language-julia hljs">z.foo.bar isa PropDicts.MissingProperty
18+
z.foo.bar = 42
19+
z.foo.bar == 42</code></pre><p><code>PropDict</code>s can be read/written to/from JSON files using <a href="#PropDicts.readprops"><code>readprops</code></a> and <a href="#PropDicts.writeprops"><code>writeprops</code></a>.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Like with <code>Base.Dict</code>, mutating a <code>PropDict</code> is <em>not</em> thread safe.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/oschulz/PropDicts.jl/blob/2cc2071e559599f49eb494ebf160115933b0f43f/src/propdict.jl#L4-L52">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="PropDicts.readprops" href="#PropDicts.readprops"><code>PropDicts.readprops</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">readprops(filename::AbstractString; subst_pathvar::Bool = true, subst_env::Bool = true, trim_null::Bool = true)
20+
readprops(filenames::Vector{&lt;:AbstractString}; ...)</code></pre><p>Read a <a href="#PropDicts.PropDict"><code>PropDict</code></a> from a single or multiple JSON files.</p><p>If multiple files are given, they are merged into a single <code>PropDict</code> using <code>merge</code>.</p><p><code>subst_pathvar</code> controls whether <code>$_</code> should be substituted with the directory path of the/each JSON file within string values (but not field names).</p><p><code>subst_env</code> controls whether <code>$ENVVAR</code> should be substituted with the value of the each environment variable <code>ENVVAR</code> within string values (but not field names).</p><p><code>trim_null</code> controls whether JSON <code>null</code> values should be removed entirely.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/oschulz/PropDicts.jl/blob/2cc2071e559599f49eb494ebf160115933b0f43f/src/propdict.jl#L209-L227">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="PropDicts.trim_null!" href="#PropDicts.trim_null!"><code>PropDicts.trim_null!</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">trim_null!(d::AbstractDict; recursive::Bool = true)</code></pre><p>Remove values equal to <code>nothing</code> from <code>d</code>.</p><p>Operates recursively on values in <code>d</code> if <code>recursive == true</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/oschulz/PropDicts.jl/blob/2cc2071e559599f49eb494ebf160115933b0f43f/src/dictmerge.jl#L32-L38">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="PropDicts.writeprops" href="#PropDicts.writeprops"><code>PropDicts.writeprops</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">writeprops(filename, p::PropDict; multiline::Bool = false, indent::Int = 4)</code></pre><p>Write <a href="#PropDicts.PropDict"><code>PropDict</code></a> <code>p</code> to JSON file <code>filename</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/oschulz/PropDicts.jl/blob/2cc2071e559599f49eb494ebf160115933b0f43f/src/propdict.jl#L277-L281">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../LICENSE/">LICENSE »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Tuesday 19 March 2024 13:41">Tuesday 19 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)