Bump version

cceh · Sep 23, 2023 · f9392fc · f9392fc
1 parent 8a4ab71
commit f9392fc
Show file tree

Hide file tree

Showing 17 changed files with 62 additions and 36 deletions.
diff --git a/docs/_build/.buildinfo b/docs/_build/.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: 7ae0d97b33a5ecf92644856b784e478b
+config: 09c61f55f04602556a5f29ff606f7d4f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/_static/documentation_options.js b/docs/_build/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.0.3',
+    VERSION: '0.0.4',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/algorithm.html b/docs/_build/algorithm.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Collation Algorithm &mdash; super-collator 0.0.3 documentation</title>
+  <title>Collation Algorithm &mdash; super-collator 0.0.4 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -15,7 +15,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=47de8214"></script>
+        <script src="_static/documentation_options.js?v=8c5712d9"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script>window.MathJax = {"tex": {"macros": {"bs": ["\\boldsymbol"]}}}</script>
@@ -68,6 +68,7 @@
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.backtracked"><code class="docutils literal notranslate"><span class="pre">Data.backtracked</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.arrow"><code class="docutils literal notranslate"><span class="pre">Data.arrow()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.__str__"><code class="docutils literal notranslate"><span class="pre">Data.__str__()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.html"><code class="docutils literal notranslate"><span class="pre">Data.html()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.str_size"><code class="docutils literal notranslate"><span class="pre">Data.str_size()</span></code></a></li>
 </ul>
 </li>

diff --git a/docs/_build/aligner.html b/docs/_build/aligner.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Aligner &mdash; super-collator 0.0.3 documentation</title>
+  <title>Aligner &mdash; super-collator 0.0.4 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -15,7 +15,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=47de8214"></script>
+        <script src="_static/documentation_options.js?v=8c5712d9"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script>window.MathJax = {"tex": {"macros": {"bs": ["\\boldsymbol"]}}}</script>
@@ -24,7 +24,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="NGrams" href="ngrams.html" />
-    <link rel="prev" title="Overview of the Collation Algorithm" href="algorithm.html" /> 
+    <link rel="prev" title="Collation Algorithm" href="algorithm.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -50,7 +50,7 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
-<li class="toctree-l1"><a class="reference internal" href="algorithm.html">Overview of the Collation Algorithm</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="algorithm.html">Collation Algorithm</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="algorithm.html#phase-1-build-table">Phase 1 - Build Table</a></li>
 <li class="toctree-l2"><a class="reference internal" href="algorithm.html#phase-2-backtrack">Phase 2 - Backtrack</a></li>
 <li class="toctree-l2"><a class="reference internal" href="algorithm.html#parameters">Parameters</a></li>
@@ -68,6 +68,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#super_collator.aligner.Data.backtracked"><code class="docutils literal notranslate"><span class="pre">Data.backtracked</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#super_collator.aligner.Data.arrow"><code class="docutils literal notranslate"><span class="pre">Data.arrow()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#super_collator.aligner.Data.__str__"><code class="docutils literal notranslate"><span class="pre">Data.__str__()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#super_collator.aligner.Data.html"><code class="docutils literal notranslate"><span class="pre">Data.html()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#super_collator.aligner.Data.str_size"><code class="docutils literal notranslate"><span class="pre">Data.str_size()</span></code></a></li>
 </ul>
 </li>
@@ -176,19 +177,25 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="super_collator.aligner.Data.arrow">
 <span class="sig-name descname"><span class="pre">arrow</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#super_collator.aligner.Data.arrow" title="Link to this definition"></a></dt>
-<dd><p>Returns the appropriate arrow form.</p>
+<dd><p>Return the appropriate arrow form.</p>
 </dd></dl>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="super_collator.aligner.Data.__str__">
 <span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_collator.aligner.Data.__str__" title="Link to this definition"></a></dt>
-<dd><p>Return str(self).</p>
+<dd><p>Return the data as string useful for debugging.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="super_collator.aligner.Data.html">
+<span class="sig-name descname"><span class="pre">html</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#super_collator.aligner.Data.html" title="Link to this definition"></a></dt>
+<dd><p>Return the data as HTML string useful for debugging.</p>
 </dd></dl>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="super_collator.aligner.Data.str_size">
 <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">str_size</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_collator.aligner.Data.str_size" title="Link to this definition"></a></dt>
-<dd><p>The size of the string returned by __str__.</p>
+<dd><p>Return the size of the string returned by __str__.</p>
 </dd></dl>
 
 </dd></dl>
@@ -291,7 +298,7 @@
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="algorithm.html" class="btn btn-neutral float-left" title="Overview of the Collation Algorithm" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="algorithm.html" class="btn btn-neutral float-left" title="Collation Algorithm" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="ngrams.html" class="btn btn-neutral float-right" title="NGrams" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/docs/_build/doctrees/aligner.doctree b/docs/_build/doctrees/aligner.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/examples.html b/docs/_build/examples.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Examples &mdash; super-collator 0.0.3 documentation</title>
+  <title>Examples &mdash; super-collator 0.0.4 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -15,13 +15,13 @@
 
         <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=47de8214"></script>
+        <script src="_static/documentation_options.js?v=8c5712d9"></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>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Overview of the Collation Algorithm" href="algorithm.html" />
+    <link rel="next" title="Collation Algorithm" href="algorithm.html" />
     <link rel="prev" title="Super Collator" href="index.html" /> 
 </head>
 
@@ -48,7 +48,7 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Examples</a></li>
-<li class="toctree-l1"><a class="reference internal" href="algorithm.html">Overview of the Collation Algorithm</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="algorithm.html">Collation Algorithm</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="algorithm.html#phase-1-build-table">Phase 1 - Build Table</a></li>
 <li class="toctree-l2"><a class="reference internal" href="algorithm.html#phase-2-backtrack">Phase 2 - Backtrack</a></li>
 <li class="toctree-l2"><a class="reference internal" href="algorithm.html#parameters">Parameters</a></li>
@@ -66,6 +66,7 @@
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.backtracked"><code class="docutils literal notranslate"><span class="pre">Data.backtracked</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.arrow"><code class="docutils literal notranslate"><span class="pre">Data.arrow()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.__str__"><code class="docutils literal notranslate"><span class="pre">Data.__str__()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.html"><code class="docutils literal notranslate"><span class="pre">Data.html()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.str_size"><code class="docutils literal notranslate"><span class="pre">Data.str_size()</span></code></a></li>
 </ul>
 </li>
@@ -214,7 +215,7 @@ <h1>Examples<a class="headerlink" href="#examples" title="Link to this heading">
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="index.html" class="btn btn-neutral float-left" title="Super Collator" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="algorithm.html" class="btn btn-neutral float-right" title="Overview of the Collation Algorithm" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="algorithm.html" class="btn btn-neutral float-right" title="Collation Algorithm" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/docs/_build/genindex.html b/docs/_build/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; super-collator 0.0.3 documentation</title>
+  <title>Index &mdash; super-collator 0.0.4 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -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=47de8214"></script>
+        <script src="_static/documentation_options.js?v=8c5712d9"></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>
@@ -63,6 +63,7 @@
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.backtracked"><code class="docutils literal notranslate"><span class="pre">Data.backtracked</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.arrow"><code class="docutils literal notranslate"><span class="pre">Data.arrow()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.__str__"><code class="docutils literal notranslate"><span class="pre">Data.__str__()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.html"><code class="docutils literal notranslate"><span class="pre">Data.html()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.str_size"><code class="docutils literal notranslate"><span class="pre">Data.str_size()</span></code></a></li>
 </ul>
 </li>
@@ -122,6 +123,7 @@ <h1 id="index">Index</h1>
  | <a href="#B"><strong>B</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
+ | <a href="#H"><strong>H</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#N"><strong>N</strong></a>
@@ -197,6 +199,14 @@ <h2 id="E">E</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="H">H</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="aligner.html#super_collator.aligner.Data.html">html() (Data method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>

diff --git a/docs/_build/index.html b/docs/_build/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Super Collator &mdash; super-collator 0.0.3 documentation</title>
+  <title>Super Collator &mdash; super-collator 0.0.4 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -15,7 +15,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=47de8214"></script>
+        <script src="_static/documentation_options.js?v=8c5712d9"></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>
@@ -65,6 +65,7 @@
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.backtracked"><code class="docutils literal notranslate"><span class="pre">Data.backtracked</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.arrow"><code class="docutils literal notranslate"><span class="pre">Data.arrow()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.__str__"><code class="docutils literal notranslate"><span class="pre">Data.__str__()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.html"><code class="docutils literal notranslate"><span class="pre">Data.html()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="aligner.html#super_collator.aligner.Data.str_size"><code class="docutils literal notranslate"><span class="pre">Data.str_size()</span></code></a></li>
 </ul>
 </li>