From refs/heads/main 3c5e53e

Prismadic · Mar 14, 2024 · 5a236a9 · 5a236a9
1 parent 568636d
commit 5a236a9
Show file tree

Hide file tree

Showing 24 changed files with 559 additions and 568 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 614d4a05f8b85be2064defc40be7dc21
+config: e9e6e805cdec29b68a3909a576e3adb1
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+#GitHub Pages
+
+Last update of sphinx html documentation from [3c5e53e](https://github.com/Prismadic/hygiene/tree/3c5e53ef3749ec8e10cec213de14c7dbb6fd31e9)
diff --git a/_modules/hygiene/payload/boxing/boxing.html b/_modules/hygiene/payload/boxing/boxing.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hygiene.payload.boxing.boxing &mdash; hygiene latest documentation</title>
+  <title>hygiene.payload.boxing.boxing &mdash; hygiene initial documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=7254e0c9" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../../../_static/documentation_options.js?v=c6e86fd7"></script>
+        <script src="../../../../_static/documentation_options.js?v=51ad5368"></script>
         <script src="../../../../_static/doctools.js?v=888ff710"></script>
         <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../_static/js/theme.js"></script>
@@ -35,7 +35,7 @@
               <img src="../../../../_static/hygiene.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                v0.0.9
+                v0.0.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
@@ -45,8 +45,62 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption" role="heading"><span class="caption-text">Packages &amp; useful classes</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../../hygiene.payload.html">hygiene.payload package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../../hygiene.payload.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../../../hygiene.payload.boxing.html">hygiene.payload.boxing package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../../../hygiene.payload.boxing.html#submodules">Submodules</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../../../hygiene.payload.boxing.html#module-hygiene.payload.boxing.boxing">hygiene.payload.boxing.boxing module</a><ul>
+<li class="toctree-l5"><a class="reference internal" href="../../../../hygiene.payload.boxing.html#hygiene.payload.boxing.boxing.Payload"><code class="docutils literal notranslate"><span class="pre">Payload</span></code></a><ul>
+<li class="toctree-l6"><a class="reference internal" href="../../../../hygiene.payload.boxing.html#hygiene.payload.boxing.boxing.Payload.deliver"><code class="docutils literal notranslate"><span class="pre">Payload.deliver()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../../../../hygiene.payload.html#module-hygiene.payload">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../hygiene.util.html">hygiene.util package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../../hygiene.util.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../../../hygiene.util.builders.html">hygiene.util.builders package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../../../hygiene.util.builders.html#submodules">Submodules</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../../../hygiene.util.builders.html#hygiene-util-builders-csv-module">hygiene.util.builders.csv module</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="../../../../hygiene.util.common.html">hygiene.util.common package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../../../hygiene.util.common.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l5"><a class="reference internal" href="../../../../hygiene.util.common.helpers.html">hygiene.util.common.helpers package</a><ul>
+<li class="toctree-l6"><a class="reference internal" href="../../../../hygiene.util.common.helpers.html#module-contents">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="../../../../hygiene.util.formatters.html">hygiene.util.formatters package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../../../hygiene.util.formatters.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l5"><a class="reference internal" href="../../../../hygiene.util.formatters.single.html">hygiene.util.formatters.single package</a><ul>
+<li class="toctree-l6"><a class="reference internal" href="../../../../hygiene.util.formatters.single.html#submodules">Submodules</a></li>
+<li class="toctree-l6"><a class="reference internal" href="../../../../hygiene.util.formatters.single.html#hygiene-util-formatters-single-csv-module">hygiene.util.formatters.single.csv module</a></li>
+<li class="toctree-l6"><a class="reference internal" href="../../../../hygiene.util.formatters.single.html#hygiene-util-formatters-single-json-module">hygiene.util.formatters.single.json module</a></li>
+<li class="toctree-l6"><a class="reference internal" href="../../../../hygiene.util.formatters.single.html#hygiene-util-formatters-single-yaml-module">hygiene.util.formatters.single.yaml module</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
         </div>
       </div>
     </nav>
@@ -72,8 +126,8 @@
            <div itemprop="articleBody">
 
   <h1>Source code for hygiene.payload.boxing.boxing</h1><div class="highlight"><pre>
-<span></span><span class="kn">from</span> <span class="nn">hygiene.util.formatters.single</span> <span class="kn">import</span> <span class="n">json</span><span class="p">,</span> <span class="n">yaml</span>
-<span class="kn">from</span> <span class="nn">hygiene.util.builders</span> <span class="kn">import</span> <span class="n">csv</span>
+<span></span><span class="kn">from</span> <span class="nn">hygiene.utils.formatters.single</span> <span class="kn">import</span> <span class="n">json</span><span class="p">,</span> <span class="n">yaml</span>
+<span class="kn">from</span> <span class="nn">hygiene.utils.builders</span> <span class="kn">import</span> <span class="n">csv</span>
 <span class="kn">import</span> <span class="nn">os</span>
 
 <div class="viewcode-block" id="Payload">
@@ -112,7 +166,6 @@ <h1>Source code for hygiene.payload.boxing.boxing</h1><div class="highlight"><pr
             <span class="n">form</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">DataFormatter</span><span class="p">(</span><span class="n">fmt</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">fmt</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
             <span class="k">return</span> <span class="n">form</span><span class="o">.</span><span class="n">format</span><span class="p">()</span>
         <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
-            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span>
             <span class="k">try</span><span class="p">:</span>
                 <span class="n">form</span> <span class="o">=</span> <span class="n">yaml</span><span class="o">.</span><span class="n">DataFormatter</span><span class="p">(</span><span class="n">fmt</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">fmt</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="nb">dict</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">))</span>
             <span class="k">except</span><span class="p">:</span>

diff --git a/_modules/hygiene/singleton.html b/_modules/hygiene/singleton.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>hygiene.singleton &mdash; hygiene latest documentation</title>
+  <title>hygiene.singleton &mdash; hygiene initial documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=7254e0c9" />
       <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="../../_static/documentation_options.js?v=c6e86fd7"></script>
+        <script src="../../_static/documentation_options.js?v=51ad5368"></script>
         <script src="../../_static/doctools.js?v=888ff710"></script>
         <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/js/theme.js"></script>
@@ -35,7 +35,7 @@
               <img src="../../_static/hygiene.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                v0.0.9
+                v0.0.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -45,8 +45,62 @@
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption" role="heading"><span class="caption-text">Packages &amp; useful classes</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../hygiene.payload.html">hygiene.payload package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../hygiene.payload.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../hygiene.payload.boxing.html">hygiene.payload.boxing package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../hygiene.payload.boxing.html#submodules">Submodules</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../hygiene.payload.boxing.html#module-hygiene.payload.boxing.boxing">hygiene.payload.boxing.boxing module</a><ul>
+<li class="toctree-l5"><a class="reference internal" href="../../hygiene.payload.boxing.html#hygiene.payload.boxing.boxing.Payload"><code class="docutils literal notranslate"><span class="pre">Payload</span></code></a><ul>
+<li class="toctree-l6"><a class="reference internal" href="../../hygiene.payload.boxing.html#hygiene.payload.boxing.boxing.Payload.deliver"><code class="docutils literal notranslate"><span class="pre">Payload.deliver()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../../hygiene.payload.html#module-hygiene.payload">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../../hygiene.util.html">hygiene.util package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../hygiene.util.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../hygiene.util.builders.html">hygiene.util.builders package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../hygiene.util.builders.html#submodules">Submodules</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../hygiene.util.builders.html#hygiene-util-builders-csv-module">hygiene.util.builders.csv module</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="../../hygiene.util.common.html">hygiene.util.common package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../hygiene.util.common.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l5"><a class="reference internal" href="../../hygiene.util.common.helpers.html">hygiene.util.common.helpers package</a><ul>
+<li class="toctree-l6"><a class="reference internal" href="../../hygiene.util.common.helpers.html#module-contents">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="../../hygiene.util.formatters.html">hygiene.util.formatters package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../hygiene.util.formatters.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l5"><a class="reference internal" href="../../hygiene.util.formatters.single.html">hygiene.util.formatters.single package</a><ul>
+<li class="toctree-l6"><a class="reference internal" href="../../hygiene.util.formatters.single.html#submodules">Submodules</a></li>
+<li class="toctree-l6"><a class="reference internal" href="../../hygiene.util.formatters.single.html#hygiene-util-formatters-single-csv-module">hygiene.util.formatters.single.csv module</a></li>
+<li class="toctree-l6"><a class="reference internal" href="../../hygiene.util.formatters.single.html#hygiene-util-formatters-single-json-module">hygiene.util.formatters.single.json module</a></li>
+<li class="toctree-l6"><a class="reference internal" href="../../hygiene.util.formatters.single.html#hygiene-util-formatters-single-yaml-module">hygiene.util.formatters.single.yaml module</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
         </div>
       </div>
     </nav>

diff --git a/_modules/index.html b/_modules/index.html
@@ -69,19 +69,13 @@
 <li class="toctree-l2"><a class="reference internal" href="../hygiene.util.html#subpackages">Subpackages</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../hygiene.util.builders.html">hygiene.util.builders package</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="../hygiene.util.builders.html#submodules">Submodules</a></li>
-<li class="toctree-l4"><a class="reference internal" href="../hygiene.util.builders.html#module-hygiene.util.builders.csv">hygiene.util.builders.csv module</a><ul>
-<li class="toctree-l5"><a class="reference internal" href="../hygiene.util.builders.html#hygiene.util.builders.csv.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a><ul>
-<li class="toctree-l6"><a class="reference internal" href="../hygiene.util.builders.html#hygiene.util.builders.csv.Sequence.build"><code class="docutils literal notranslate"><span class="pre">Sequence.build()</span></code></a></li>
-</ul>
-</li>
-</ul>
-</li>
+<li class="toctree-l4"><a class="reference internal" href="../hygiene.util.builders.html#hygiene-util-builders-csv-module">hygiene.util.builders.csv module</a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="../hygiene.util.common.html">hygiene.util.common package</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="../hygiene.util.common.html#subpackages">Subpackages</a><ul>
 <li class="toctree-l5"><a class="reference internal" href="../hygiene.util.common.helpers.html">hygiene.util.common.helpers package</a><ul>
-<li class="toctree-l6"><a class="reference internal" href="../hygiene.util.common.helpers.html#module-hygiene.util.common.helpers">Module contents</a></li>
+<li class="toctree-l6"><a class="reference internal" href="../hygiene.util.common.helpers.html#module-contents">Module contents</a></li>
 </ul>
 </li>
 </ul>
@@ -92,27 +86,9 @@
 <li class="toctree-l4"><a class="reference internal" href="../hygiene.util.formatters.html#subpackages">Subpackages</a><ul>
 <li class="toctree-l5"><a class="reference internal" href="../hygiene.util.formatters.single.html">hygiene.util.formatters.single package</a><ul>
 <li class="toctree-l6"><a class="reference internal" href="../hygiene.util.formatters.single.html#submodules">Submodules</a></li>
-<li class="toctree-l6"><a class="reference internal" href="../hygiene.util.formatters.single.html#module-hygiene.util.formatters.single.csv">hygiene.util.formatters.single.csv module</a><ul>
-<li class="toctree-l7"><a class="reference internal" href="../hygiene.util.formatters.single.html#hygiene.util.formatters.single.csv.DataFormatter"><code class="docutils literal notranslate"><span class="pre">DataFormatter</span></code></a><ul>
-<li class="toctree-l8"><a class="reference internal" href="../hygiene.util.formatters.single.html#hygiene.util.formatters.single.csv.DataFormatter.format"><code class="docutils literal notranslate"><span class="pre">DataFormatter.format()</span></code></a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li class="toctree-l6"><a class="reference internal" href="../hygiene.util.formatters.single.html#module-hygiene.util.formatters.single.json">hygiene.util.formatters.single.json module</a><ul>
-<li class="toctree-l7"><a class="reference internal" href="../hygiene.util.formatters.single.html#hygiene.util.formatters.single.json.DataFormatter"><code class="docutils literal notranslate"><span class="pre">DataFormatter</span></code></a><ul>
-<li class="toctree-l8"><a class="reference internal" href="../hygiene.util.formatters.single.html#hygiene.util.formatters.single.json.DataFormatter.format"><code class="docutils literal notranslate"><span class="pre">DataFormatter.format()</span></code></a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li class="toctree-l6"><a class="reference internal" href="../hygiene.util.formatters.single.html#module-hygiene.util.formatters.single.yaml">hygiene.util.formatters.single.yaml module</a><ul>
-<li class="toctree-l7"><a class="reference internal" href="../hygiene.util.formatters.single.html#hygiene.util.formatters.single.yaml.DataFormatter"><code class="docutils literal notranslate"><span class="pre">DataFormatter</span></code></a><ul>
-<li class="toctree-l8"><a class="reference internal" href="../hygiene.util.formatters.single.html#hygiene.util.formatters.single.yaml.DataFormatter.format"><code class="docutils literal notranslate"><span class="pre">DataFormatter.format()</span></code></a></li>
-</ul>
-</li>
-</ul>
-</li>
+<li class="toctree-l6"><a class="reference internal" href="../hygiene.util.formatters.single.html#hygiene-util-formatters-single-csv-module">hygiene.util.formatters.single.csv module</a></li>
+<li class="toctree-l6"><a class="reference internal" href="../hygiene.util.formatters.single.html#hygiene-util-formatters-single-json-module">hygiene.util.formatters.single.json module</a></li>
+<li class="toctree-l6"><a class="reference internal" href="../hygiene.util.formatters.single.html#hygiene-util-formatters-single-yaml-module">hygiene.util.formatters.single.yaml module</a></li>
 </ul>
 </li>
 </ul>
@@ -151,10 +127,6 @@
   <h1>All modules for which code is available</h1>
 <ul><li><a href="hygiene/payload/boxing/boxing.html">hygiene.payload.boxing.boxing</a></li>
 <li><a href="hygiene/singleton.html">hygiene.singleton</a></li>
-<li><a href="hygiene/util/builders/csv.html">hygiene.util.builders.csv</a></li>
-<li><a href="hygiene/util/formatters/single/csv.html">hygiene.util.formatters.single.csv</a></li>
-<li><a href="hygiene/util/formatters/single/json.html">hygiene.util.formatters.single.json</a></li>
-<li><a href="hygiene/util/formatters/single/yaml.html">hygiene.util.formatters.single.yaml</a></li>
 </ul>
 
            </div>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#GitHub Pages

		Last update of sphinx html documentation from [3c5e53e](https://github.com/Prismadic/hygiene/tree/3c5e53ef3749ec8e10cec213de14c7dbb6fd31e9)