Skip to content

Commit 3bd2ff1

Browse files
dirkroordadirkroorda
committed
docs update
1 parent 00ff164 commit 3bd2ff1

22 files changed

Lines changed: 244 additions & 231 deletions

‎index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tff/about/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ <h1 id="documents">Documents</h1>
3333
<details class="source">
3434
<summary>
3535
<span>Expand source code</span>
36-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/about/__init__.py#L1-L5" class="git-link">Browse git</a>
36+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/about/__init__.py#L1-L5" class="git-link">Browse git</a>
3737
</summary>
3838
<pre><code class="python">&#34;&#34;&#34;
3939
# Documents

‎tff/about/install.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ <h1 id="install">Install</h1>
3737
<details class="source">
3838
<summary>
3939
<span>Expand source code</span>
40-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/about/install.py#L1-L3" class="git-link">Browse git</a>
40+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/about/install.py#L1-L3" class="git-link">Browse git</a>
4141
</summary>
4242
<pre><code class="python">&#34;&#34;&#34;
4343
.. include:: ../docs/about/install.md

‎tff/about/releases.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ <h3 id="100">1.0.0</h3>
4343
<details class="source">
4444
<summary>
4545
<span>Expand source code</span>
46-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/about/releases.py#L1-L3" class="git-link">Browse git</a>
46+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/about/releases.py#L1-L3" class="git-link">Browse git</a>
4747
</summary>
4848
<pre><code class="python">&#34;&#34;&#34;
4949
.. include:: ../docs/about/releases.md

‎tff/cheatsheet.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ <h1 id="command-line-tools">Command-line tools</h1>
171171
<details class="source">
172172
<summary>
173173
<span>Expand source code</span>
174-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/cheatsheet.py#L1-L3" class="git-link">Browse git</a>
174+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/cheatsheet.py#L1-L3" class="git-link">Browse git</a>
175175
</summary>
176176
<pre><code class="python">&#34;&#34;&#34;
177177
.. include:: docs/main/cheatsheet.md

‎tff/convert/addnlp.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ <h2 id="examples">Examples</h2>
114114
<details class="source">
115115
<summary>
116116
<span>Expand source code</span>
117-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L1-L1612" class="git-link">Browse git</a>
117+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L1-L1612" class="git-link">Browse git</a>
118118
</summary>
119119
<pre><code class="python">&#34;&#34;&#34;Add data from an NLP pipeline.
120120

@@ -1760,7 +1760,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
17601760
<details class="source">
17611761
<summary>
17621762
<span>Expand source code</span>
1763-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L1600-L1608" class="git-link">Browse git</a>
1763+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L1600-L1608" class="git-link">Browse git</a>
17641764
</summary>
17651765
<pre><code class="python">def main():
17661766
(good, tasks, params, flags) = readArgs(&#34;tf-addnlp&#34;, HELP, TASKS, PARAMS, FLAGS)
@@ -1859,7 +1859,7 @@ <h2 id="parameters">Parameters</h2>
18591859
<details class="source">
18601860
<summary>
18611861
<span>Expand source code</span>
1862-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L198-L1597" class="git-link">Browse git</a>
1862+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L198-L1597" class="git-link">Browse git</a>
18631863
</summary>
18641864
<pre><code class="python">class NLPipeline(CheckImport):
18651865
def __init__(
@@ -3296,7 +3296,7 @@ <h2 id="returns">Returns</h2>
32963296
<details class="source">
32973297
<summary>
32983298
<span>Expand source code</span>
3299-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L448-L652" class="git-link">Browse git</a>
3299+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L448-L652" class="git-link">Browse git</a>
33003300
</summary>
33013301
<pre><code class="python">def generatePlain(self):
33023302
&#34;&#34;&#34;Generates a plain text out of a data source.
@@ -3529,7 +3529,7 @@ <h2 id="returns">Returns</h2>
35293529
<details class="source">
35303530
<summary>
35313531
<span>Expand source code</span>
3532-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L409-L446" class="git-link">Browse git</a>
3532+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L409-L446" class="git-link">Browse git</a>
35333533
</summary>
35343534
<pre><code class="python">def getElementInfo(self, verbose=None):
35353535
&#34;&#34;&#34;Analyse the schema.
@@ -3653,7 +3653,7 @@ <h2 id="returns">Returns</h2>
36533653
<details class="source">
36543654
<summary>
36553655
<span>Expand source code</span>
3656-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L660-L1113" class="git-link">Browse git</a>
3656+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L660-L1113" class="git-link">Browse git</a>
36573657
</summary>
36583658
<pre><code class="python">def ingest(
36593659
self,
@@ -4176,7 +4176,7 @@ <h2 id="returns">Returns</h2>
41764176
<details class="source">
41774177
<summary>
41784178
<span>Expand source code</span>
4179-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L1115-L1437" class="git-link">Browse git</a>
4179+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L1115-L1437" class="git-link">Browse git</a>
41804180
</summary>
41814181
<pre><code class="python">def ingestNlpOutput(self, positions, tkStream, sentenceStream, entityStream):
41824182
&#34;&#34;&#34;Ingests NLP output such as tokens in a dataset. Tokens become the new slots.
@@ -4511,7 +4511,7 @@ <h2 id="returns">Returns</h2>
45114511
<details class="source">
45124512
<summary>
45134513
<span>Expand source code</span>
4514-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L654-L658" class="git-link">Browse git</a>
4514+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L654-L658" class="git-link">Browse git</a>
45154515
</summary>
45164516
<pre><code class="python">def lingo(self, *args, **kwargs):
45174517
if not self.importOK():
@@ -4541,7 +4541,7 @@ <h2 id="parameters">Parameters</h2>
45414541
<details class="source">
45424542
<summary>
45434543
<span>Expand source code</span>
4544-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L336-L407" class="git-link">Browse git</a>
4544+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L336-L407" class="git-link">Browse git</a>
45454545
</summary>
45464546
<pre><code class="python">def loadApp(self, app=None, verbose=None):
45474547
&#34;&#34;&#34;Loads a given TF app or loads the TF app based on the working directory.
@@ -4650,7 +4650,7 @@ <h2 id="returns">Returns</h2>
46504650
<details class="source">
46514651
<summary>
46524652
<span>Expand source code</span>
4653-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/addnlp.py#L1439-L1597" class="git-link">Browse git</a>
4653+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/addnlp.py#L1439-L1597" class="git-link">Browse git</a>
46544654
</summary>
46554655
<pre><code class="python">def task(
46564656
self,

‎tff/convert/app/app.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ <h1 class="title">Module <code>tff.convert.app.app</code></h1>
3131
<details class="source">
3232
<summary>
3333
<span>Expand source code</span>
34-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/app/app.py#L1-L41" class="git-link">Browse git</a>
34+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/app/app.py#L1-L41" class="git-link">Browse git</a>
3535
</summary>
3636
<pre><code class="python">import types
3737
from tf.advanced.app import App
@@ -91,7 +91,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
9191
<details class="source">
9292
<summary>
9393
<span>Expand source code</span>
94-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/app/app.py#L9-L10" class="git-link">Browse git</a>
94+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/app/app.py#L9-L10" class="git-link">Browse git</a>
9595
</summary>
9696
<pre><code class="python">def fmt_layout(app, n, **kwargs):
9797
return app._wrapHtml(n)</code></pre>
@@ -146,7 +146,7 @@ <h2 id="parameters">Parameters</h2>
146146
<details class="source">
147147
<summary>
148148
<span>Expand source code</span>
149-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/app/app.py#L13-L41" class="git-link">Browse git</a>
149+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/app/app.py#L13-L41" class="git-link">Browse git</a>
150150
</summary>
151151
<pre><code class="python">class TfApp(App):
152152
def __init__(app, *args, **kwargs):

‎tff/convert/helpers.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ <h1 class="title">Module <code>tff.convert.helpers</code></h1>
3131
<details class="source">
3232
<summary>
3333
<span>Expand source code</span>
34-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L1-L883" class="git-link">Browse git</a>
34+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L1-L883" class="git-link">Browse git</a>
3535
</summary>
3636
<pre><code class="python">import re
3737
from textwrap import dedent
@@ -1050,7 +1050,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
10501050
<details class="source">
10511051
<summary>
10521052
<span>Expand source code</span>
1053-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L265-L340" class="git-link">Browse git</a>
1053+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L265-L340" class="git-link">Browse git</a>
10541054
</summary>
10551055
<pre><code class="python">def checkModel(kind, thisModel, verbose):
10561056
modelDefault = (
@@ -1138,7 +1138,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
11381138
<details class="source">
11391139
<summary>
11401140
<span>Expand source code</span>
1141-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L858-L883" class="git-link">Browse git</a>
1141+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L858-L883" class="git-link">Browse git</a>
11421142
</summary>
11431143
<pre><code class="python">def getImageLocations(app, prod, silent):
11441144
repoLocation = app.repoLocation
@@ -1176,7 +1176,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
11761176
<details class="source">
11771177
<summary>
11781178
<span>Expand source code</span>
1179-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L805-L855" class="git-link">Browse git</a>
1179+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L805-L855" class="git-link">Browse git</a>
11801180
</summary>
11811181
<pre><code class="python">def getImageSizes(scanRefDir, doCovers, silent):
11821182
sizeInfo = {}
@@ -1239,7 +1239,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
12391239
<details class="source">
12401240
<summary>
12411241
<span>Expand source code</span>
1242-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L735-L802" class="git-link">Browse git</a>
1242+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L735-L802" class="git-link">Browse git</a>
12431243
</summary>
12441244
<pre><code class="python">def getPageInfo(pageInfoDir, zoneBased, manifestLevel):
12451245
if pageInfoDir is None:
@@ -1319,7 +1319,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
13191319
<details class="source">
13201320
<summary>
13211321
<span>Expand source code</span>
1322-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L222-L237" class="git-link">Browse git</a>
1322+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L222-L237" class="git-link">Browse git</a>
13231323
</summary>
13241324
<pre><code class="python">def getWhites(text):
13251325
match = W_BEFORE.match(text)
@@ -1392,7 +1392,7 @@ <h2 id="parameters">Parameters</h2>
13921392
<details class="source">
13931393
<summary>
13941394
<span>Expand source code</span>
1395-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L606-L732" class="git-link">Browse git</a>
1395+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L606-L732" class="git-link">Browse git</a>
13961396
</summary>
13971397
<pre><code class="python">def lookupSource(cv, cur, tokenAsSlot, specs):
13981398
&#34;&#34;&#34;Looks up information from the current XML stack.
@@ -1531,7 +1531,7 @@ <h2 id="parameters">Parameters</h2>
15311531
<details class="source">
15321532
<summary>
15331533
<span>Expand source code</span>
1534-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L343-L359" class="git-link">Browse git</a>
1534+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L343-L359" class="git-link">Browse git</a>
15351535
</summary>
15361536
<pre><code class="python">def matchModel(properties, tag, atts):
15371537
if tag == properties[&#34;element&#34;]:
@@ -1560,7 +1560,7 @@ <h2 id="parameters">Parameters</h2>
15601560
<details class="source">
15611561
<summary>
15621562
<span>Expand source code</span>
1563-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L258-L262" class="git-link">Browse git</a>
1563+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L258-L262" class="git-link">Browse git</a>
15641564
</summary>
15651565
<pre><code class="python">def repTokens(tokens):
15661566
text = []
@@ -1577,7 +1577,7 @@ <h2 id="parameters">Parameters</h2>
15771577
<details class="source">
15781578
<summary>
15791579
<span>Expand source code</span>
1580-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L362-L413" class="git-link">Browse git</a>
1580+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L362-L413" class="git-link">Browse git</a>
15811581
</summary>
15821582
<pre><code class="python">def setUp(kind):
15831583
helpText = f&#34;&#34;&#34;
@@ -1641,7 +1641,7 @@ <h2 id="parameters">Parameters</h2>
16411641
<details class="source">
16421642
<summary>
16431643
<span>Expand source code</span>
1644-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L240-L255" class="git-link">Browse git</a>
1644+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L240-L255" class="git-link">Browse git</a>
16451645
</summary>
16461646
<pre><code class="python">def tokenize(line):
16471647
tokens = []
@@ -1669,7 +1669,7 @@ <h2 id="parameters">Parameters</h2>
16691669
<details class="source">
16701670
<summary>
16711671
<span>Expand source code</span>
1672-
<a href="https://github.com/annotation/text-fabric-factory/blob/f98dffab07a121ac8a2d097f3a51b2099a959d1c/tff/convert/helpers.py#L416-L603" class="git-link">Browse git</a>
1672+
<a href="https://github.com/annotation/text-fabric-factory/blob/529894f6a13419a3ee38e7d01700611f7a82ffe8/tff/convert/helpers.py#L416-L603" class="git-link">Browse git</a>
16731673
</summary>
16741674
<pre><code class="python">def tweakTrans(
16751675
template,

0 commit comments

Comments
 (0)