DOC refresh for v3.1.1

jacksonllee · Mar 18, 2021 · 67fbc2b · 67fbc2b
1 parent 923c7e9
commit 67fbc2b
Show file tree

Hide file tree

Showing 90 changed files with 1,754 additions and 4,298 deletions.
diff --git a/docs/.buildinfo b/docs/.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: 07a18dc687d0cca46ce42d04c62cc218
+config: 75cfa23d9065195478078020c4e3419d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -3,11 +3,11 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8">
+  <meta charset="utf-8" />
 
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Overview: module code &mdash; PyCantonese 3.1.0 documentation</title>
+  <title>Overview: module code &mdash; PyCantonese 3.1.1 documentation</title>
 
 
 
@@ -18,10 +18,12 @@
 
     <link rel="shortcut icon" href="../_static/pycantonese-logo.ico"/>
 
+
 
 
-    <link rel="canonical" href="https://pycantonese.org/_modules/index.html"/>
+
 
+    <link rel="canonical" href="https://pycantonese.org/_modules/index.html" />
 
 
   <!--[if lt IE 9]>
@@ -53,7 +55,7 @@
 
 
 
-            <a href="../index.html" class="icon icon-home" alt="Documentation Home"> PyCantonese
+            <a href="../index.html" class="icon icon-home"> PyCantonese
 
 
 
@@ -66,7 +68,7 @@
 
 
               <div class="version">
-                3.1.0
+                3.1.1
               </div>
 
 
@@ -164,50 +166,54 @@
 <li class="toctree-l3"><a class="reference internal" href="../changelog.html#security">Security</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id2">[3.1.0] - 2021-02-21</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id3">Added</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id4">Fixed</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id2">[3.1.1] - 2021-03-18</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id3">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id5">[3.0.0] - 2020-10-25</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id6">Added</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id7">Changed</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="../changelog.html#api-breaking-changes">API-breaking Changes</a></li>
-<li class="toctree-l4"><a class="reference internal" href="../changelog.html#non-api-breaking-changes">Non-API-breaking Changes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id4">[3.1.0] - 2021-02-21</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id5">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id6">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id8">Deprecated</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id9">Security</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id7">[3.0.0] - 2020-10-25</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id8">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id9">Changed</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../changelog.html#api-breaking-changes">API-breaking Changes</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../changelog.html#non-api-breaking-changes">Non-API-breaking Changes</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id10">[2.4.1] - 2020-10-10</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id11">Fixed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id10">Deprecated</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id11">Security</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id12">[2.4.0] - 2020-10-10</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id13">Added</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id12">[2.4.1] - 2020-10-10</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id13">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id14">[2.3.0] - 2020-07-24</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id14">[2.4.0] - 2020-10-10</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../changelog.html#id15">Added</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id16">Removed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id17">[2.2.0] - 2018-06-30</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id18">Added</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id16">[2.3.0] - 2020-07-24</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id17">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id18">Removed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id19">[2.1.0] - 2018-06-11</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id19">[2.2.0] - 2018-06-30</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../changelog.html#id20">Added</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id21">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id22">[2.0.0] - 2016-02-06</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id28">[1.0] - 2015-09-06</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id21">[2.1.0] - 2018-06-11</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id22">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../changelog.html#id23">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id24">[2.0.0] - 2016-02-06</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id30">[1.0] - 2015-09-06</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../changelog.html#dev-2015-09-02">[1.0dev] - 2015-09-02</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id29">[0.2.1] - 2015-01-25</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id30">[0.2] - 2015-01-22</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id31">[0.1] - 2014-12-17</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id31">[0.2.1] - 2015-01-25</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id32">[0.2] - 2015-01-22</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../changelog.html#id33">[0.1] - 2014-12-17</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../papers.html">Research Outputs</a></li>
@@ -251,6 +257,8 @@
 
 
 
+
+
 <div role="navigation" aria-label="breadcrumbs navigation">
 
   <ul class="wy-breadcrumbs">
@@ -289,28 +297,25 @@ <h1>All modules for which code is available</h1>
 
           </div>
           <footer>
-
 
   <hr/>
 
   <div role="contentinfo">
     <p>
-
-        &copy; Copyright 2014-2021, Jackson L. Lee | Documentation last updated on February 22, 2021
+        &#169; Copyright 2014-2021, Jackson L. Lee | Documentation last updated on March 18, 2021.
 
     </p>
   </div>
 
 
 
-    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
+    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
 
-    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
 
     provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
 </footer>
-
         </div>
       </div>
 
@@ -336,6 +341,7 @@ <h1>All modules for which code is available</h1>
     })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
 
     ga('create', 'UA-181803559', 'auto');
+
     ga('send', 'pageview');
     </script>
 

diff --git a/docs/_modules/pycantonese/corpus.html b/docs/_modules/pycantonese/corpus.html
@@ -3,11 +3,11 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8">
+  <meta charset="utf-8" />
 
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>pycantonese.corpus &mdash; PyCantonese 3.1.0 documentation</title>
+  <title>pycantonese.corpus &mdash; PyCantonese 3.1.1 documentation</title>
 
 
 
@@ -18,10 +18,12 @@
 
     <link rel="shortcut icon" href="../../_static/pycantonese-logo.ico"/>
 
+
 
 
-    <link rel="canonical" href="https://pycantonese.org/_modules/pycantonese/corpus.html"/>
+
 
+    <link rel="canonical" href="https://pycantonese.org/_modules/pycantonese/corpus.html" />
 
 
   <!--[if lt IE 9]>
@@ -53,7 +55,7 @@
 
 
 
-            <a href="../../index.html" class="icon icon-home" alt="Documentation Home"> PyCantonese
+            <a href="../../index.html" class="icon icon-home"> PyCantonese
 
 
 
@@ -66,7 +68,7 @@
 
 
               <div class="version">
-                3.1.0
+                3.1.1
               </div>
 
 
@@ -164,50 +166,54 @@
 <li class="toctree-l3"><a class="reference internal" href="../../changelog.html#security">Security</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id2">[3.1.0] - 2021-02-21</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id3">Added</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id4">Fixed</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id2">[3.1.1] - 2021-03-18</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id3">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id5">[3.0.0] - 2020-10-25</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id6">Added</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id7">Changed</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="../../changelog.html#api-breaking-changes">API-breaking Changes</a></li>
-<li class="toctree-l4"><a class="reference internal" href="../../changelog.html#non-api-breaking-changes">Non-API-breaking Changes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id4">[3.1.0] - 2021-02-21</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id5">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id6">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id8">Deprecated</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id9">Security</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id7">[3.0.0] - 2020-10-25</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id8">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id9">Changed</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../changelog.html#api-breaking-changes">API-breaking Changes</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../changelog.html#non-api-breaking-changes">Non-API-breaking Changes</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id10">[2.4.1] - 2020-10-10</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id11">Fixed</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id10">Deprecated</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id11">Security</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id12">[2.4.0] - 2020-10-10</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id13">Added</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id12">[2.4.1] - 2020-10-10</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id13">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id14">[2.3.0] - 2020-07-24</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id14">[2.4.0] - 2020-10-10</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id15">Added</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id16">Removed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id17">[2.2.0] - 2018-06-30</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id18">Added</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id16">[2.3.0] - 2020-07-24</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id17">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id18">Removed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id19">[2.1.0] - 2018-06-11</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id19">[2.2.0] - 2018-06-30</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id20">Added</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id21">Fixed</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id22">[2.0.0] - 2016-02-06</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id28">[1.0] - 2015-09-06</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id21">[2.1.0] - 2018-06-11</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id22">Added</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../changelog.html#id23">Fixed</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id24">[2.0.0] - 2016-02-06</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id30">[1.0] - 2015-09-06</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../changelog.html#dev-2015-09-02">[1.0dev] - 2015-09-02</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id29">[0.2.1] - 2015-01-25</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id30">[0.2] - 2015-01-22</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id31">[0.1] - 2014-12-17</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id31">[0.2.1] - 2015-01-25</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id32">[0.2] - 2015-01-22</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../changelog.html#id33">[0.1] - 2014-12-17</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../../papers.html">Research Outputs</a></li>
@@ -251,6 +257,8 @@
 
 
 
+
+
 <div role="navigation" aria-label="breadcrumbs navigation">
 
   <ul class="wy-breadcrumbs">
@@ -635,28 +643,25 @@ <h1>Source code for pycantonese.corpus</h1><div class="highlight"><pre>
 
           </div>
           <footer>
-
 
   <hr/>
 
   <div role="contentinfo">
     <p>
-
-        &copy; Copyright 2014-2021, Jackson L. Lee | Documentation last updated on February 22, 2021
+        &#169; Copyright 2014-2021, Jackson L. Lee | Documentation last updated on March 18, 2021.
 
     </p>
   </div>
 
 
 
-    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
+    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
 
-    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
 
     provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
 </footer>
-
         </div>
       </div>
 
@@ -682,6 +687,7 @@ <h1>Source code for pycantonese.corpus</h1><div class="highlight"><pre>
     })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
 
     ga('create', 'UA-181803559', 'auto');
+
     ga('send', 'pageview');
     </script>