Skip to content

Commit

Permalink
Deployed e3de09d to 0.3.0 with MkDocs 1.6.0 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@nhairs
nhairs committed Aug 30, 2024
1 parent 2ce1e99 commit b34095e
Show file tree
Hide file tree
Showing 7 changed files with 120 additions and 28 deletions.
4 changes: 2 additions & 2 deletions 0.3.0/applications/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -971,9 +971,9 @@ <h2 id="configuration-files">Configuration Files<a class="headerlink" href="#con
<p>In general Pillar applications are designed to be customised more through config files than they are commandline arguments. Configuration is loaded from two locations:</p>
<p><strong>Default Config</strong> - The default config is set via the <code>default_config</code> class attribute. It is expected to be of type <code>Dict[str, Any]</code>.</p>
<p>If you are instantiating the application multiple times it is safe to use basic types including <code>dict</code> and <code>list</code> as these will be deep copied by the <a href="#the-config-loader">config loader</a>. It is <strong>unsafe</strong> to use custom classes as by default these are not copied (and thus will be shared by all instances of your application).</p>
<p><strong>Arguments</strong> - Config files passed as arguments will automatically be loaded via the <code>ConfigLoader</code> in the order they are provided.</p>
<p><strong>Arguments</strong> - Config files can be passed as individual files via <code>--config</code> or as a directory of files using <code>--config-dir</code> to the be loaded using the <code>ConfigLoader</code>. Config is first loaded from config directories with individual files being loaded in alphabetical/lexical order. Config is then loaded from individual files in the order they were provided.</p>
<p>This can be disabled by setting the <code>config_args_enabled</code> class attribute to <code>False</code>. Note: even if the config args are disabled the config loader will still be created (with the default config passed through).</p>
<p>By default the <code>--config</code> argument is optional, however it can be made mandatory by setting the <code>config_required</code> attributes to <code>True</code>.</p>
<p>By default providing config via the <code>--config</code> or <code>--config-dir</code> arguments is optional, however it can be made mandatory by setting the <code>config_required</code> attributes to <code>True</code>.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="k">class</span> <span class="nc">MyApplication</span><span class="p">(</span><span class="n">Application</span><span class="p">):</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a> <span class="n">config_required</span> <span class="o">=</span> <span class="kc">True</span>
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> <span class="n">default_config</span> <span class="o">=</span> <span class="p">{</span>
Expand Down
112 changes: 102 additions & 10 deletions 0.3.0/changelog/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -365,18 +365,57 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#020" class="md-nav__link">
<a href="#030-2024-08-29" class="md-nav__link">
<span class="md-ellipsis">
0.2.0
0.3.0 - 2024-08-29
</span>
</a>

<nav class="md-nav" aria-label="0.3.0 - 2024-08-29">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#added" class="md-nav__link">
<span class="md-ellipsis">
Added
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#010" class="md-nav__link">
<a href="#020-2024-01-23" class="md-nav__link">
<span class="md-ellipsis">
0.2.0 - 2024-01-23
</span>
</a>

<nav class="md-nav" aria-label="0.2.0 - 2024-01-23">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#added_1" class="md-nav__link">
<span class="md-ellipsis">
0.1.0
Added
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#010-2023-12-30" class="md-nav__link">
<span class="md-ellipsis">
0.1.0 - 2023-12-30
</span>
</a>

Expand Down Expand Up @@ -671,18 +710,57 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#020" class="md-nav__link">
<a href="#030-2024-08-29" class="md-nav__link">
<span class="md-ellipsis">
0.3.0 - 2024-08-29
</span>
</a>

<nav class="md-nav" aria-label="0.3.0 - 2024-08-29">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#added" class="md-nav__link">
<span class="md-ellipsis">
Added
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#020-2024-01-23" class="md-nav__link">
<span class="md-ellipsis">
0.2.0
0.2.0 - 2024-01-23
</span>
</a>

<nav class="md-nav" aria-label="0.2.0 - 2024-01-23">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#added_1" class="md-nav__link">
<span class="md-ellipsis">
Added
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#010" class="md-nav__link">
<a href="#010-2023-12-30" class="md-nav__link">
<span class="md-ellipsis">
0.1.0
0.1.0 - 2023-12-30
</span>
</a>

Expand All @@ -707,12 +785,26 @@


<h1 id="change-log">Change Log<a class="headerlink" href="#change-log" title="Permanent link">🔗</a></h1>
<h2 id="020">0.2.0<a class="headerlink" href="#020" title="Permanent link">🔗</a></h2>
<p>All notable changes to this project will be documented in this file.</p>
<p>The format is based on <a href="https://keepachangelog.com/en/1.1.0/">Keep a Changelog</a>,
and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
<h2 id="030-2024-08-29"><a href="https://github.com/nhairs/pillar/compare/v0.2.0...v0.3.0">0.3.0</a> - 2024-08-29<a class="headerlink" href="#030-2024-08-29" title="Permanent link">🔗</a></h2>
<h3 id="added">Added<a class="headerlink" href="#added" title="Permanent link">🔗</a></h3>
<ul>
<li>Allow loading config files from directory (<code>ConfigLoader.load_config_directory</code> and <code>--config-dir</code>)</li>
<li>Add example applications (<code>examples/</code>)<ul>
<li><code>config_loading.py</code> requires config arguments and prints the loaded config.</li>
<li><code>log_levels.py</code> prints sample log messages.</li>
</ul>
</li>
</ul>
<h2 id="020-2024-01-23"><a href="https://github.com/nhairs/pillar/compare/v0.1.0...v0.2.0">0.2.0</a> - 2024-01-23<a class="headerlink" href="#020-2024-01-23" title="Permanent link">🔗</a></h2>
<h3 id="added_1">Added<a class="headerlink" href="#added_1" title="Permanent link">🔗</a></h3>
<ul>
<li>Add functions for getting logger names based on class / instance.</li>
<li>Expose <code>get_logger</code> on logging mixin classes.</li>
</ul>
<h2 id="010">0.1.0<a class="headerlink" href="#010" title="Permanent link">🔗</a></h2>
<h2 id="010-2023-12-30">0.1.0 - 2023-12-30<a class="headerlink" href="#010-2023-12-30" title="Permanent link">🔗</a></h2>
<ul>
<li>Initial release</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion 0.3.0/reference/pillar/application/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1067,7 +1067,7 @@ <h2 id="pillar.application.Application" class="doc doc-heading">
</td>
<td>
<div class="doc-md-description">
<p>(class) providing a config file via args is mandatory.</p>
<p>(class) providing a config file or directory via args is mandatory.</p>
</div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion 0.3.0/search/search_index.json
View file

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions 0.3.0/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,57 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://nhairs.github.io/pillar/latest/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/applications/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/changelog/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/quickstart/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/reference/pillar/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/reference/pillar/application/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/reference/pillar/config/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/reference/pillar/dataclass/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/reference/pillar/exception/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/reference/pillar/logging/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://nhairs.github.io/pillar/latest/reference/pillar/util/</loc>
<lastmod>2024-08-29</lastmod>
<lastmod>2024-08-30</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified 0.3.0/sitemap.xml.gz
View file
Binary file not shown.
6 changes: 3 additions & 3 deletions versions.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
],
"properties": {
"git_branch": "main",
"git_commit": "9dcefa6fa0d614555cbf8dfef35df1c501c4babe",
"git_commit_short": "9dcefa6",
"build_timestamp": "1724942593"
"git_commit": "e3de09d146f156576778fece74b5088aa5dcc1b1",
"git_commit_short": "e3de09d",
"build_timestamp": "1724979752"
}
},
{
Expand Down

0 comments on commit b34095e

Please sign in to comment.