docs update

annotation · Apr 21, 2024 · 6896826 · 6896826
1 parent 0f6d6ac
commit 6896826
Show file tree

Hide file tree

Showing 149 changed files with 1,099 additions and 1,033 deletions.
diff --git a/index.js b/index.js
diff --git a/tf/about/annotate.html b/tf/about/annotate.html
@@ -298,7 +298,7 @@ <h3 id="recommended-practice">Recommended practice</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/annotate.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/annotate.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/annotate.md

diff --git a/tf/about/annotateBrowser.html b/tf/about/annotateBrowser.html
@@ -267,7 +267,7 @@ <h1 id="programming">Programming</h1>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/annotateBrowser.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/annotateBrowser.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/annotateBrowser.md

diff --git a/tf/about/apps.html b/tf/about/apps.html
@@ -115,7 +115,7 @@ <h3 id="two-contexts">Two contexts</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/apps.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/apps.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/apps.md

diff --git a/tf/about/background.html b/tf/about/background.html
@@ -155,7 +155,7 @@ <h2 id="history">History</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/background.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/background.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/background.md

diff --git a/tf/about/browser.html b/tf/about/browser.html
@@ -174,7 +174,7 @@ <h3 id="unicode-in-excel-csvs">UNICODE in Excel CSVs</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/browser.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/browser.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/browser.md

diff --git a/tf/about/clientmanual.html b/tf/about/clientmanual.html
@@ -565,7 +565,7 @@ <h1 id="credits">Credits</h1>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/clientmanual.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/clientmanual.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/clientmanual.md

diff --git a/tf/about/code.html b/tf/about/code.html
@@ -98,7 +98,7 @@ <h2 id="writing">Writing</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/code.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/code.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/code.md

diff --git a/tf/about/corpora.html b/tf/about/corpora.html
@@ -351,7 +351,7 @@ <h3 id="extra-data">Extra data</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/corpora.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/corpora.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/corpora.md

diff --git a/tf/about/datamodel.html b/tf/about/datamodel.html
@@ -265,7 +265,7 @@ <h2 id="serializing-and-pre-computing">Serializing and pre-computing</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/datamodel.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/datamodel.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/datamodel.md

diff --git a/tf/about/datasharing.html b/tf/about/datasharing.html
@@ -362,7 +362,7 @@ <h3 id="more-modules-at-the-same-time">More modules at the same time</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/datasharing.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/datasharing.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/datasharing.md

diff --git a/tf/about/displaydesign.html b/tf/about/displaydesign.html
@@ -151,7 +151,7 @@ <h3 id="output">Output</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/displaydesign.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/displaydesign.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/displaydesign.md

diff --git a/tf/about/faq.html b/tf/about/faq.html
@@ -161,7 +161,7 @@ <h3 id="github-rate-limit-exceeded">GitHub Rate Limit Exceeded!</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/faq.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/faq.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/faq.md

diff --git a/tf/about/fileformats.html b/tf/about/fileformats.html
@@ -158,7 +158,7 @@ <h3 id="single-values">Single values</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/fileformats.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/fileformats.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/fileformats.md

diff --git a/tf/about/index.html b/tf/about/index.html
@@ -33,7 +33,7 @@ <h1 id="documents">Documents</h1>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/__init__.py#L1-L5" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/__init__.py#L1-L5" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 # Documents

diff --git a/tf/about/install.html b/tf/about/install.html
@@ -108,7 +108,7 @@ <h4 id="note-for-linux-users">Note for Linux users</h4>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/install.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/install.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/install.md

diff --git a/tf/about/manual.html b/tf/about/manual.html
@@ -390,7 +390,7 @@ <h2 id="keyboard-shortcuts">Keyboard shortcuts</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/manual.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/manual.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/manual.md

diff --git a/tf/about/optimizations.html b/tf/about/optimizations.html
@@ -187,7 +187,7 @@ <h3 id="edge-features">Edge features</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/optimizations.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/optimizations.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/optimizations.md

diff --git a/tf/about/releases.html b/tf/about/releases.html
@@ -42,6 +42,14 @@ <h1 id="release-notes">Release notes</h1>
 <pre><code class="language-sh">pip install -e .
 </code></pre>
 <h2 id="12">12</h2>
+<h3 id="124">12.4</h3>
+<h4 id="1240">12.4.0</h4>
+<p>2024-04-21</p>
+<p>Support for <a href="https://docs.marimo.io/index.html">Marimo notebooks</a>.</p>
+<p>TF detects when its run in a notebook, and also in what kind of notebook:
+<code>ipython</code> (~ Jupyter) or <code>marimo</code>. When it needs to display material in the output
+of a cell, it will choose the methods that are suitable for the kind of notebook it
+is working in.</p>
 <h3 id="123">12.3</h3>
 <h4 id="1237">12.3.7</h4>
 <p>2024-04-19</p>
@@ -360,7 +368,7 @@ <h2 id="older-releases">Older releases</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/releases.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/releases.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/releases.md
@@ -433,6 +441,10 @@ <h1>Index</h1>
 <ul>
 <li><a href="#release-notes">Release notes</a><ul>
 <li><a href="#12">12</a><ul>
+<li><a href="#124">12.4</a><ul>
+<li><a href="#1240">12.4.0</a></li>
+</ul>
+</li>
 <li><a href="#123">12.3</a><ul>
 <li><a href="#1237">12.3.7</a></li>
 <li><a href="#1236">12.3.6</a></li>

diff --git a/tf/about/releasesold.html b/tf/about/releasesold.html
@@ -3430,7 +3430,7 @@ <h5 id="changed">Changed</h5>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/releasesold.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/releasesold.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/releasesold.md

diff --git a/tf/about/searchdesign.html b/tf/about/searchdesign.html
@@ -477,7 +477,7 @@ <h3 id="small-first-strategy">Small-first strategy</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/searchdesign.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/searchdesign.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/searchdesign.md

diff --git a/tf/about/searchusage.html b/tf/about/searchusage.html
@@ -776,7 +776,7 @@ <h5 id="implementation">Implementation</h5>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/searchusage.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/searchusage.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/searchusage.md

diff --git a/tf/about/tests.html b/tf/about/tests.html
@@ -71,7 +71,7 @@ <h2 id="relations">Relations</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/tests.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/tests.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/tests.md

diff --git a/tf/about/use.html b/tf/about/use.html
@@ -90,7 +90,7 @@ <h2 id="tf-api">TF API</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/use.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/use.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/use.md

diff --git a/tf/about/usefunc.html b/tf/about/usefunc.html
@@ -419,7 +419,7 @@ <h2 id="prevent-data-loading">Prevent data loading</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/usefunc.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/usefunc.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/usefunc.md

diff --git a/tf/about/variants.html b/tf/about/variants.html
@@ -438,7 +438,7 @@ <h3 id="the-stack">The stack</h3>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/variants.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/variants.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/variants.md

diff --git a/tf/about/volumes.html b/tf/about/volumes.html
@@ -323,7 +323,7 @@ <h2 id="reflection">Reflection</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/about/volumes.py#L1-L3" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/about/volumes.py#L1-L3" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 .. include:: ../docs/about/volumes.md

diff --git a/tf/advanced/annotate.html b/tf/advanced/annotate.html
@@ -34,7 +34,7 @@ <h1 class="title">Module <code>tf.advanced.annotate</code></h1>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/advanced/annotate.py#L1-L26" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/advanced/annotate.py#L1-L26" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;
 Enable manual annotation APIs.
@@ -84,7 +84,7 @@ <h2 id="parameters">Parameters</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/advanced/annotate.py#L17-L26" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/advanced/annotate.py#L17-L26" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">def annotateApi(app):
     &#34;&#34;&#34;Produce the interchange functions API.
@@ -106,7 +106,7 @@ <h2 id="parameters">Parameters</h2>
 <details class="source">
 <summary>
 <span>Expand source code</span>
-<a href="https://github.com/annotation/text-fabric/blob/df917a27893b7551738715ef87201b1eb4a4f4b7/tf/advanced/annotate.py#L13-L14" class="git-link">Browse git</a>
+<a href="https://github.com/annotation/text-fabric/blob/d0219bb2c1dbd10ad5c493846effea8cd99f52f0/tf/advanced/annotate.py#L13-L14" class="git-link">Browse git</a>
 </summary>
 <pre><code class="python">def makeNer(app):
     return NER(app)</code></pre>