Skip to content

Commit 7cb7043

Browse files
committed
Generate reference docs.
1 parent 2c49aeb commit 7cb7043

20 files changed

Lines changed: 989 additions & 951 deletions

src/py/site/404.html

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@
1414

1515

1616
<link rel="icon" href="/plotly/kaleido/assets/images/favicon.png">
17-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.5">
17+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.15">
1818

1919

2020

2121
<title>kaleido</title>
2222

2323

2424

25-
<link rel="stylesheet" href="/plotly/kaleido/assets/stylesheets/main.8608ea7d.min.css">
25+
<link rel="stylesheet" href="/plotly/kaleido/assets/stylesheets/main.342714a4.min.css">
2626

2727

2828

@@ -176,6 +176,7 @@
176176
<a href="/plotly/kaleido/." class="md-nav__link">
177177

178178

179+
179180
<span class="md-ellipsis">
180181
Readme
181182

@@ -197,6 +198,7 @@
197198
<a href="/plotly/kaleido/examples/" class="md-nav__link">
198199

199200

201+
200202
<span class="md-ellipsis">
201203
Examples
202204

@@ -218,6 +220,7 @@
218220
<a href="/plotly/kaleido/api/kaleido/" class="md-nav__link">
219221

220222

223+
221224
<span class="md-ellipsis">
222225
User API Reference
223226

@@ -239,6 +242,7 @@
239242
<a href="/plotly/kaleido/api/kaleido.errors/" class="md-nav__link">
240243

241244

245+
242246
<span class="md-ellipsis">
243247
kaleido.errors
244248

@@ -313,10 +317,12 @@ <h1>404 - Not found</h1>
313317
</div>
314318

315319

316-
<script id="__config" type="application/json">{"base": "/plotly/kaleido", "features": ["navigation.indexes"], "search": "/plotly/kaleido/assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
320+
321+
322+
<script id="__config" type="application/json">{"base": "/plotly/kaleido", "features": ["navigation.indexes"], "search": "/plotly/kaleido/assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
317323

318324

319-
<script src="/plotly/kaleido/assets/javascripts/bundle.f1b6f286.min.js"></script>
325+
<script src="/plotly/kaleido/assets/javascripts/bundle.56ea9cef.min.js"></script>
320326

321327

322328
</body>

src/py/site/api/kaleido.errors/index.html

Lines changed: 18 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@
1818

1919

2020
<link rel="icon" href="../../assets/images/favicon.png">
21-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.5">
21+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.15">
2222

2323

2424

2525
<title>kaleido.errors - kaleido</title>
2626

2727

2828

29-
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">
29+
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
3030

3131

3232

@@ -185,6 +185,7 @@
185185
<a href="../.." class="md-nav__link">
186186

187187

188+
188189
<span class="md-ellipsis">
189190
Readme
190191

@@ -206,6 +207,7 @@
206207
<a href="../../examples/" class="md-nav__link">
207208

208209

210+
209211
<span class="md-ellipsis">
210212
Examples
211213

@@ -227,6 +229,7 @@
227229
<a href="../kaleido/" class="md-nav__link">
228230

229231

232+
230233
<span class="md-ellipsis">
231234
User API Reference
232235

@@ -257,6 +260,7 @@
257260
<label class="md-nav__link md-nav__link--active" for="__toc">
258261

259262

263+
260264
<span class="md-ellipsis">
261265
kaleido.errors
262266

@@ -269,6 +273,7 @@
269273
<a href="./" class="md-nav__link md-nav__link--active">
270274

271275

276+
272277
<span class="md-ellipsis">
273278
kaleido.errors
274279

@@ -293,25 +298,15 @@
293298
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
294299

295300
<li class="md-nav__item">
296-
<a href="#classes" class="md-nav__link">
297-
<span class="md-ellipsis">
298-
Classes
299-
</span>
300-
</a>
301-
302-
<nav class="md-nav" aria-label="Classes">
303-
<ul class="md-nav__list">
304-
305-
<li class="md-nav__item">
306301
<a href="#JavascriptError" class="md-nav__link">
307302
<span class="md-ellipsis">
308303
class JavascriptError()
309304
</span>
310305
</a>
311306

312307
</li>
313-
314-
<li class="md-nav__item">
308+
309+
<li class="md-nav__item">
315310
<a href="#KaleidoError" class="md-nav__link">
316311
<span class="md-ellipsis">
317312
class KaleidoError()
@@ -322,16 +317,6 @@
322317
<ul class="md-nav__list">
323318

324319
<li class="md-nav__item">
325-
<a href="#methods" class="md-nav__link">
326-
<span class="md-ellipsis">
327-
methods
328-
</span>
329-
</a>
330-
331-
<nav class="md-nav" aria-label="methods">
332-
<ul class="md-nav__list">
333-
334-
<li class="md-nav__item">
335320
<a href="#KaleidoError-a__init__" class="md-nav__link">
336321
<span class="md-ellipsis">
337322
__init__(...)
@@ -343,16 +328,6 @@
343328
</ul>
344329
</nav>
345330

346-
</li>
347-
348-
</ul>
349-
</nav>
350-
351-
</li>
352-
353-
</ul>
354-
</nav>
355-
356331
</li>
357332

358333
</ul>
@@ -390,25 +365,15 @@
390365
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
391366

392367
<li class="md-nav__item">
393-
<a href="#classes" class="md-nav__link">
394-
<span class="md-ellipsis">
395-
Classes
396-
</span>
397-
</a>
398-
399-
<nav class="md-nav" aria-label="Classes">
400-
<ul class="md-nav__list">
401-
402-
<li class="md-nav__item">
403368
<a href="#JavascriptError" class="md-nav__link">
404369
<span class="md-ellipsis">
405370
class JavascriptError()
406371
</span>
407372
</a>
408373

409374
</li>
410-
411-
<li class="md-nav__item">
375+
376+
<li class="md-nav__item">
412377
<a href="#KaleidoError" class="md-nav__link">
413378
<span class="md-ellipsis">
414379
class KaleidoError()
@@ -419,16 +384,6 @@
419384
<ul class="md-nav__list">
420385

421386
<li class="md-nav__item">
422-
<a href="#methods" class="md-nav__link">
423-
<span class="md-ellipsis">
424-
methods
425-
</span>
426-
</a>
427-
428-
<nav class="md-nav" aria-label="methods">
429-
<ul class="md-nav__list">
430-
431-
<li class="md-nav__item">
432387
<a href="#KaleidoError-a__init__" class="md-nav__link">
433388
<span class="md-ellipsis">
434389
__init__(...)
@@ -440,16 +395,6 @@
440395
</ul>
441396
</nav>
442397

443-
</li>
444-
445-
</ul>
446-
</nav>
447-
448-
</li>
449-
450-
</ul>
451-
</nav>
452-
453398
</li>
454399

455400
</ul>
@@ -475,21 +420,19 @@ <h1 id="module-errors">module: <code>errors</code></h1>
475420
<div class="long-description text">
476421
<p>A list of errors available from the kaleido package.</p>
477422
</div>
478-
<h2 id="classes">Classes</h2>
479423
<div class="individual-class">
480-
<h3 id="JavascriptError"><code>class JavascriptError(RuntimeError):</code></h3>
424+
<h3 id="JavascriptError"><span class="reserved-word">class</span><span class="fade"> JavascriptError(RuntimeError):</span></h3>
481425
<div class="long-description text">
482426
<p>Used to report errors from javascript.</p>
483427
</div>
484428
</div>
485429
<div class="individual-class">
486-
<h3 id="KaleidoError"><code>class KaleidoError(Exception):</code></h3>
430+
<h3 id="KaleidoError"><span class="reserved-word">class</span><span class="fade"> KaleidoError(Exception):</span></h3>
487431
<div class="long-description text">
488432
<p>An error to interpret errors from Kaleido's JS side.</p>
489433
</div>
490-
<h4 id="methods">methods</h4>
491434
<div class="indent">
492-
<h5 id="KaleidoError-a__init__"><code>__init__(self, code, message)</code></h5>
435+
<h5 id="KaleidoError-a__init__"><span class="reserved-word">method</span> <strong>init</strong>(self, code, message)</h5>
493436
<div class="long-description">
494437
<div class="text">
495438
<p>Construct an error object.</p>
@@ -554,10 +497,12 @@ <h5 id="KaleidoError-a__init__"><code>__init__(self, code, message)</code></h5>
554497
</div>
555498

556499

557-
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.indexes"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
500+
501+
502+
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.indexes"], "search": "../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
558503

559504

560-
<script src="../../assets/javascripts/bundle.f1b6f286.min.js"></script>
505+
<script src="../../assets/javascripts/bundle.56ea9cef.min.js"></script>
561506

562507

563508
</body>

0 commit comments

Comments
 (0)