Deployed e676de5 to 1.6 with MkDocs 1.2.4 and mike 2.0.0

clueboard · Jan 27, 2024 · 6ca547a · 6ca547a
1 parent 2fe6552
commit 6ca547a
Show file tree

Hide file tree

Showing 31 changed files with 42 additions and 434 deletions.
diff --git a/1.6/api_milc/index.html b/1.6/api_milc/index.html
@@ -777,7 +777,7 @@ <h2 id="milc-objects">MILC Objects<a class="headerlink" href="#milc-objects" tit
 <p>MILC - An Opinionated Batteries Included Framework</p>
 <p><a id="milc.MILC.__init__"></a></p>
 <h4 id="__init__">__init__<a class="headerlink" href="#__init__" title="Permanent link">&para;</a></h4>
-<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">author</span><span class="p">)</span>
+<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">author</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 </code></pre></div>
 <p>Initialize the MILC object.</p>
 <p><a id="milc.MILC.echo"></a></p>
@@ -836,7 +836,7 @@ <h4 id="add_argument">add_argument<a class="headerlink" href="#add_argument" tit
 <p>Wrapper to add arguments and track whether they were passed on the command line.</p>
 <p><a id="milc.MILC.initialize_logging"></a></p>
 <h4 id="initialize_logging">initialize_logging<a class="headerlink" href="#initialize_logging" title="Permanent link">&para;</a></h4>
-<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">initialize_logging</span><span class="p">()</span>
+<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">initialize_logging</span><span class="p">(</span><span class="n">logger</span><span class="p">)</span>
 </code></pre></div>
 <p>Prepare the defaults for the logging infrastructure.</p>
 <p><a id="milc.MILC.acquire_lock"></a></p>

diff --git a/1.6/metadata/index.html b/1.6/metadata/index.html
@@ -452,8 +452,8 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#environment-based-setup" class="md-nav__link">
-    Environment based setup
+  <a href="#custom-loggers" class="md-nav__link">
+    Custom Loggers
   </a>
 
 </li>
@@ -718,8 +718,8 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#environment-based-setup" class="md-nav__link">
-    Environment based setup
+  <a href="#custom-loggers" class="md-nav__link">
+    Custom Loggers
   </a>
 
 </li>
@@ -755,9 +755,16 @@ <h1 id="milc-metadata">MILC Metadata<a class="headerlink" href="#milc-metadata"
 <p class="admonition-title">Danger</p>
 <p>Do not import <code>set_metadata</code> and <code>cli</code> at the same time! When you run <code>set_metadata</code> the <code>cli</code> object will be replaced, but your existing import will continue to reference the old <code>cli</code> object.</p>
 </div>
-<h2 id="environment-based-setup">Environment based setup<a class="headerlink" href="#environment-based-setup" title="Permanent link">&para;</a></h2>
-<p>Earlier versions of MILC used the environment variables <code>MILC_APP_NAME</code>, <code>MILC_APP_VERSION</code>, and <code>MILC_AUTHOR_NAME</code> to set this information. While this is supported in MILC 1.4.x it will throw a <code>DeprecationWarning</code> and will be removed in a later version of MILC.</p>
-<p>You can supress this warning by setting the environment variable <code>MILC_IGNORE_DEPRECATED</code>.</p>
+<h2 id="custom-loggers">Custom Loggers<a class="headerlink" href="#custom-loggers" title="Permanent link">&para;</a></h2>
+<p>You can also use this to pass in custom loggers.</p>
+<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">milc</span> <span class="kn">import</span> <span class="n">set_metadata</span>
+
+<span class="kn">from</span> <span class="nn">my_program</span> <span class="kn">import</span> <span class="n">custom_logger</span>
+
+<span class="n">set_metadata</span><span class="p">(</span><span class="n">logger</span><span class="o">=</span><span class="n">custom_logger</span><span class="p">)</span>
+
+<span class="kn">from</span> <span class="nn">milc</span> <span class="kn">import</span> <span class="n">cli</span>
+</code></pre></div>
 
 
             </article>

diff --git a/1.6/search/search_index.json b/1.6/search/search_index.json
diff --git a/1.6/sitemap.xml b/1.6/sitemap.xml
@@ -2,122 +2,122 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://milc.clueboard.co/1.6/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/ANSI/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/api__in_argv/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/api__sparkline/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/api_ansi/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/api_attrdict/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/api_configuration/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/api_emoji/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/api_milc/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/api_questions/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/api_subcommand_config/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/argcomplete/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/argument_parsing/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/breaking_changes/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/configuration/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/installation/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/logging/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/metadata/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/sparklines/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/spinners/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/subcommand_config/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/subprocesses/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/threading/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://milc.clueboard.co/1.6/tutorial/</loc>
-         <lastmod>2023-06-13</lastmod>
+         <lastmod>2024-01-27</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/1.6/sitemap.xml.gz b/1.6/sitemap.xml.gz
diff --git a/latest b/latest
@@ -0,0 +1 @@
+1.6
diff --git a/latest/404.html b/latest/404.html
diff --git a/latest/ANSI/index.html b/latest/ANSI/index.html
diff --git a/latest/api__in_argv/index.html b/latest/api__in_argv/index.html
diff --git a/latest/api__sparkline/index.html b/latest/api__sparkline/index.html
diff --git a/latest/api_ansi/index.html b/latest/api_ansi/index.html
diff --git a/latest/api_attrdict/index.html b/latest/api_attrdict/index.html
diff --git a/latest/api_configuration/index.html b/latest/api_configuration/index.html
diff --git a/latest/api_emoji/index.html b/latest/api_emoji/index.html
diff --git a/latest/api_milc/index.html b/latest/api_milc/index.html
diff --git a/latest/api_questions/index.html b/latest/api_questions/index.html