DOC refresh sphinx docs

jacksonllee · Mar 29, 2024 · 71921b0 · 71921b0
1 parent 8757810
commit 71921b0
Show file tree

Hide file tree

Showing 20 changed files with 309 additions and 281 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: 561af476f52e55288ea1e2f65209503e
+config: 0ee24d2a44b8861394f630c19f501df0
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -6,7 +6,7 @@
         <link rel="canonical" href="https://pylangacq.org/_modules/index.html" />
 
     <!-- Generated with Sphinx 7.1.2 and Furo 2023.09.10 -->
-        <title>Overview: module code - PyLangAcq 0.19.0 documentation</title>
+        <title>Overview: module code - PyLangAcq 0.19.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
@@ -124,7 +124,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">PyLangAcq 0.19.0 documentation</div></a>
+      <a href="../index.html"><div class="brand">PyLangAcq 0.19.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -147,7 +147,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">PyLangAcq 0.19.0 documentation</span>
+  <span class="sidebar-brand-text">PyLangAcq 0.19.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -213,7 +213,7 @@ <h1>All modules for which code is available</h1>
         <div class="bottom-of-page">
           <div class="left-details">
             <div class="copyright">
-                Copyright &#169; 2015-2023, Jackson L. Lee | PyLangAcq 0.19.0 | Documentation last updated on December 13, 2023
+                Copyright &#169; 2015-2024, Jackson L. Lee | PyLangAcq 0.19.1 | Documentation last updated on March 29, 2024
             </div>
             Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
@@ -233,7 +233,7 @@ <h1>All modules for which code is available</h1>
 
     </aside>
   </div>
-</div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3de8224"></script>
+</div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=17a6063d"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/docs/_modules/pylangacq/chat.html b/docs/_modules/pylangacq/chat.html
@@ -6,7 +6,7 @@
         <link rel="canonical" href="https://pylangacq.org/_modules/pylangacq/chat.html" />
 
     <!-- Generated with Sphinx 7.1.2 and Furo 2023.09.10 -->
-        <title>pylangacq.chat - PyLangAcq 0.19.0 documentation</title>
+        <title>pylangacq.chat - PyLangAcq 0.19.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b76e3c8a" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
@@ -124,7 +124,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../index.html"><div class="brand">PyLangAcq 0.19.0 documentation</div></a>
+      <a href="../../index.html"><div class="brand">PyLangAcq 0.19.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -147,7 +147,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
 
 
-  <span class="sidebar-brand-text">PyLangAcq 0.19.0 documentation</span>
+  <span class="sidebar-brand-text">PyLangAcq 0.19.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -1666,6 +1666,11 @@ <h1>Source code for pylangacq.chat</h1><div class="highlight"><pre>
         <span class="n">result_list</span> <span class="o">=</span> <span class="p">[]</span>
 
         <span class="k">for</span> <span class="n">tiermarker_to_line</span> <span class="ow">in</span> <span class="n">all_tiers</span><span class="p">:</span>
+            <span class="c1"># TODO: Handle the new tiers for Universal Dependencies</span>
+            <span class="k">for</span> <span class="n">unhandled_tier</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">&quot;</span><span class="si">%u</span><span class="s2">mor&quot;</span><span class="p">,</span> <span class="s2">&quot;</span><span class="si">%u</span><span class="s2">gra&quot;</span><span class="p">):</span>
+                <span class="k">if</span> <span class="n">unhandled_tier</span> <span class="ow">in</span> <span class="n">tiermarker_to_line</span><span class="p">:</span>
+                    <span class="k">del</span> <span class="n">tiermarker_to_line</span><span class="p">[</span><span class="n">unhandled_tier</span><span class="p">]</span>
+
             <span class="n">participant_code</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_participant_code</span><span class="p">(</span><span class="n">tiermarker_to_line</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
 
             <span class="k">if</span> <span class="n">participant_code</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
@@ -2149,7 +2154,7 @@ <h1>Source code for pylangacq.chat</h1><div class="highlight"><pre>
         <div class="bottom-of-page">
           <div class="left-details">
             <div class="copyright">
-                Copyright &#169; 2015-2023, Jackson L. Lee | PyLangAcq 0.19.0 | Documentation last updated on December 13, 2023
+                Copyright &#169; 2015-2024, Jackson L. Lee | PyLangAcq 0.19.1 | Documentation last updated on March 29, 2024
             </div>
             Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
@@ -2169,7 +2174,7 @@ <h1>Source code for pylangacq.chat</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=b3de8224"></script>
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=17a6063d"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../../_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/docs/_modules/pylangacq/objects.html b/docs/_modules/pylangacq/objects.html
@@ -6,7 +6,7 @@
         <link rel="canonical" href="https://pylangacq.org/_modules/pylangacq/objects.html" />
 
     <!-- Generated with Sphinx 7.1.2 and Furo 2023.09.10 -->
-        <title>pylangacq.objects - PyLangAcq 0.19.0 documentation</title>
+        <title>pylangacq.objects - PyLangAcq 0.19.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b76e3c8a" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
@@ -124,7 +124,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../index.html"><div class="brand">PyLangAcq 0.19.0 documentation</div></a>
+      <a href="../../index.html"><div class="brand">PyLangAcq 0.19.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -147,7 +147,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
 
 
-  <span class="sidebar-brand-text">PyLangAcq 0.19.0 documentation</span>
+  <span class="sidebar-brand-text">PyLangAcq 0.19.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -420,7 +420,7 @@ <h1>Source code for pylangacq.objects</h1><div class="highlight"><pre>
         <div class="bottom-of-page">
           <div class="left-details">
             <div class="copyright">
-                Copyright &#169; 2015-2023, Jackson L. Lee | PyLangAcq 0.19.0 | Documentation last updated on December 13, 2023
+                Copyright &#169; 2015-2024, Jackson L. Lee | PyLangAcq 0.19.1 | Documentation last updated on March 29, 2024
             </div>
             Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
@@ -440,7 +440,7 @@ <h1>Source code for pylangacq.objects</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=b3de8224"></script>
+</div><script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=17a6063d"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../../_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.19.0',
+    VERSION: '0.19.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/api.html b/docs/api.html
@@ -7,7 +7,7 @@
         <link rel="canonical" href="https://pylangacq.org/api.html" />
 
     <!-- Generated with Sphinx 7.1.2 and Furo 2023.09.10 -->
-        <title>API Reference - PyLangAcq 0.19.0 documentation</title>
+        <title>API Reference - PyLangAcq 0.19.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b76e3c8a" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
@@ -125,7 +125,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">PyLangAcq 0.19.0 documentation</div></a>
+      <a href="index.html"><div class="brand">PyLangAcq 0.19.1 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -148,7 +148,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
 
 
-  <span class="sidebar-brand-text">PyLangAcq 0.19.0 documentation</span>
+  <span class="sidebar-brand-text">PyLangAcq 0.19.1 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -1628,7 +1628,7 @@ <h2>Helper Functions<a class="headerlink" href="#helper-functions" title="Permal
         <div class="bottom-of-page">
           <div class="left-details">
             <div class="copyright">
-                Copyright &#169; 2015-2023, Jackson L. Lee | PyLangAcq 0.19.0 | Documentation last updated on December 13, 2023
+                Copyright &#169; 2015-2024, Jackson L. Lee | PyLangAcq 0.19.1 | Documentation last updated on March 29, 2024
             </div>
             Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
 
@@ -1730,7 +1730,7 @@ <h2>Helper Functions<a class="headerlink" href="#helper-functions" title="Permal
 
     </aside>
   </div>
-</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=b3de8224"></script>
+</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=17a6063d"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>