Skip to content

Commit d46bfbb

Browse files
chrisgdtchrisgdt
committed
Update doc (fix links within list ul ol)
1 parent 9be94c7 commit d46bfbb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+547
-601
lines changed

‎delbot-core/docs/assets/main.js‎

Lines changed: 2 additions & 52 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎delbot-core/docs/assets/style.css‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
/* Light */
33
--light-color-background: #f2f4f8;
44
--light-color-background-secondary: #eff0f1;
5+
--light-color-warning-text: #222;
6+
--light-color-background-warning: #e6e600;
57
--light-color-icon-background: var(--light-color-background);
68
--light-color-accent: #c5c7c9;
79
--light-color-text: #222;
@@ -21,6 +23,8 @@
2123
/* Dark */
2224
--dark-color-background: #2b2e33;
2325
--dark-color-background-secondary: #1e2024;
26+
--dark-color-background-warning: #bebe00;
27+
--dark-color-warning-text: #222;
2428
--dark-color-icon-background: var(--dark-color-background-secondary);
2529
--dark-color-accent: #9096a2;
2630
--dark-color-text: #f5f5f5;
@@ -42,6 +46,8 @@
4246
:root {
4347
--color-background: var(--light-color-background);
4448
--color-background-secondary: var(--light-color-background-secondary);
49+
--color-background-warning: var(--light-color-background-warning);
50+
--color-warning-text: var(--light-color-warning-text);
4551
--color-icon-background: var(--light-color-icon-background);
4652
--color-accent: var(--light-color-accent);
4753
--color-text: var(--light-color-text);
@@ -64,6 +70,8 @@
6470
:root {
6571
--color-background: var(--dark-color-background);
6672
--color-background-secondary: var(--dark-color-background-secondary);
73+
--color-background-warning: var(--dark-color-background-warning);
74+
--color-warning-text: var(--dark-color-warning-text);
6775
--color-icon-background: var(--dark-color-icon-background);
6876
--color-accent: var(--dark-color-accent);
6977
--color-text: var(--dark-color-text);
@@ -93,6 +101,8 @@ body {
93101
:root[data-theme="light"] {
94102
--color-background: var(--light-color-background);
95103
--color-background-secondary: var(--light-color-background-secondary);
104+
--color-background-warning: var(--light-color-background-warning);
105+
--color-warning-text: var(--light-color-warning-text);
96106
--color-icon-background: var(--light-color-icon-background);
97107
--color-accent: var(--light-color-accent);
98108
--color-text: var(--light-color-text);
@@ -113,6 +123,8 @@ body {
113123
:root[data-theme="dark"] {
114124
--color-background: var(--dark-color-background);
115125
--color-background-secondary: var(--dark-color-background-secondary);
126+
--color-background-warning: var(--dark-color-background-warning);
127+
--color-warning-text: var(--dark-color-warning-text);
116128
--color-icon-background: var(--dark-color-icon-background);
117129
--color-accent: var(--dark-color-accent);
118130
--color-text: var(--dark-color-text);
@@ -130,6 +142,11 @@ body {
130142
--color-scheme: var(--dark-color-scheme);
131143
}
132144

145+
.always-visible,
146+
.always-visible .tsd-signatures {
147+
display: inherit !important;
148+
}
149+
133150
h1,
134151
h2,
135152
h3,
@@ -1237,6 +1254,12 @@ img {
12371254
text-decoration: line-through;
12381255
}
12391256

1257+
.warning {
1258+
padding: 1rem;
1259+
color: var(--color-warning-text);
1260+
background: var(--color-background-warning);
1261+
}
1262+
12401263
* {
12411264
scrollbar-width: thin;
12421265
scrollbar-color: var(--color-accent) var(--color-icon-background);

‎delbot-core/docs/classes/data.Data.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ <h4>Hierarchy</h4>
5151
<li><a href="data.DataMovementMatrix.html" class="tsd-signature-type" data-tsd-kind="Class">DataMovementMatrix</a></li>
5252
<li><a href="data.DataFeatures.html" class="tsd-signature-type" data-tsd-kind="Class">DataFeatures</a></li></ul></li></ul></section><aside class="tsd-sources">
5353
<ul>
54-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L42">src/data.ts:42</a></li></ul></aside>
54+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L42">src/data.ts:42</a></li></ul></aside>
5555
<section class="tsd-panel-group tsd-index-group">
5656
<section class="tsd-panel tsd-index-panel">
5757
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -90,7 +90,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
9090
<h5>args: <a href="../interfaces/data.DataProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">DataProperties</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
9191
<h4 class="tsd-returns-title">Returns <a href="data.Data.html" class="tsd-signature-type" data-tsd-kind="Class">Data</a></h4><aside class="tsd-sources">
9292
<ul>
93-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L67">src/data.ts:67</a></li></ul></aside></li></ul></section></section>
93+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L67">src/data.ts:67</a></li></ul></aside></li></ul></section></section>
9494
<section class="tsd-panel-group tsd-member-group">
9595
<h2>Properties</h2>
9696
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="mayNormalizeData" class="tsd-anchor"></a>
@@ -101,28 +101,28 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</co
101101
of the model will fail.</p>
102102
</div><aside class="tsd-sources">
103103
<ul>
104-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L65">src/data.ts:65</a></li></ul></aside></section>
104+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L65">src/data.ts:65</a></li></ul></aside></section>
105105
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="numClasses" class="tsd-anchor"></a>
106106
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>num<wbr/>Classes</span><a href="#numClasses" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
107107
<div class="tsd-signature">num<wbr/>Classes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">1</span></div>
108108
<div class="tsd-comment tsd-typography"><p>The number of class for labels and model output, 1 or 2 for binary classification.</p>
109109
</div><aside class="tsd-sources">
110110
<ul>
111-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L46">src/data.ts:46</a></li></ul></aside></section>
111+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L46">src/data.ts:46</a></li></ul></aside></section>
112112
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="xSize" class="tsd-anchor"></a>
113113
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>x<wbr/>Size</span><a href="#xSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
114114
<div class="tsd-signature">x<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
115115
<div class="tsd-comment tsd-typography"><p>The second shape of all 3d tensors (or first in case we ignore the batch size), defined in subclasses.</p>
116116
</div><aside class="tsd-sources">
117117
<ul>
118-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L52">src/data.ts:52</a></li></ul></aside></section>
118+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L52">src/data.ts:52</a></li></ul></aside></section>
119119
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="ySize" class="tsd-anchor"></a>
120120
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>y<wbr/>Size</span><a href="#ySize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
121121
<div class="tsd-signature">y<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
122122
<div class="tsd-comment tsd-typography"><p>The third shape of 3d tensor (or second in case we ignore the batch size), defined in subclasses.</p>
123123
</div><aside class="tsd-sources">
124124
<ul>
125-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L58">src/data.ts:58</a></li></ul></aside></section></section>
125+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L58">src/data.ts:58</a></li></ul></aside></section></section>
126126
<section class="tsd-panel-group tsd-member-group">
127127
<h2>Methods</h2>
128128
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="addLabel" class="tsd-anchor"></a>
@@ -148,23 +148,23 @@ <h5>userIndex: <span class="tsd-signature-type">number</span></h5>
148148
</div></li></ul></div>
149149
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
150150
<ul>
151-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L82">src/data.ts:82</a></li></ul></aside></li></ul></section>
151+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L82">src/data.ts:82</a></li></ul></aside></li></ul></section>
152152
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getXSize" class="tsd-anchor"></a>
153153
<h3 class="tsd-anchor-link"><span>getXSize</span><a href="#getXSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
154154
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
155155
<li class="tsd-signature tsd-anchor-link" id="getXSize.getXSize-1">getXSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getXSize.getXSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
156156
<li class="tsd-description">
157157
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
158158
<ul>
159-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L106">src/data.ts:106</a></li></ul></aside></li></ul></section>
159+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L106">src/data.ts:106</a></li></ul></aside></li></ul></section>
160160
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getYSize" class="tsd-anchor"></a>
161161
<h3 class="tsd-anchor-link"><span>getYSize</span><a href="#getYSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
162162
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
163163
<li class="tsd-signature tsd-anchor-link" id="getYSize.getYSize-1">getYSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getYSize.getYSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
164164
<li class="tsd-description">
165165
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
166166
<ul>
167-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L110">src/data.ts:110</a></li></ul></aside></li></ul></section>
167+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L110">src/data.ts:110</a></li></ul></aside></li></ul></section>
168168
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="loadDataSet" class="tsd-anchor"></a>
169169
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>load<wbr/>Data<wbr/>Set</span><a href="#loadDataSet" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
170170
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -195,15 +195,15 @@ <h5>dataset<wbr/>Data<span class="tsd-signature-symbol">: </span><span class="ts
195195
<li class="tsd-parameter">
196196
<h5>dataset<wbr/>Labels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><aside class="tsd-sources">
197197
<ul>
198-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L104">src/data.ts:104</a></li></ul></aside></li></ul></section>
198+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L104">src/data.ts:104</a></li></ul></aside></li></ul></section>
199199
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="mayNormalize" class="tsd-anchor"></a>
200200
<h3 class="tsd-anchor-link"><span>may<wbr/>Normalize</span><a href="#mayNormalize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
201201
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
202202
<li class="tsd-signature tsd-anchor-link" id="mayNormalize.mayNormalize-1">may<wbr/>Normalize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#mayNormalize.mayNormalize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
203203
<li class="tsd-description">
204204
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
205205
<ul>
206-
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/d07c50d/delbot-core/src/data.ts#L114">src/data.ts:114</a></li></ul></aside></li></ul></section></section></div>
206+
<li>Defined in <a href="https://github.com/chrisgdt/DELBOT-Mouse/blob/9be94c7/delbot-core/src/data.ts#L114">src/data.ts:114</a></li></ul></aside></li></ul></section></section></div>
207207
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
208208
<div class="tsd-navigation settings">
209209
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

0 commit comments

Comments
 (0)