Skip to content

Commit 0f2c27f

Browse files
jubajuba
committed
Built site for gh-pages
1 parent effbd5e commit 0f2c27f

21 files changed

+990
-743
lines changed

‎.nojekyll‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3635b3ee
1+
d78c194d

‎changelog.html‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
33

44
<meta charset="utf-8">
5-
<meta name="generator" content="quarto-1.7.32">
5+
<meta name="generator" content="quarto-1.8.25">
66

77
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
88

@@ -33,14 +33,15 @@
3333
<link href="./favicon.png" rel="icon" type="image/png">
3434
<script src="site_libs/quarto-html/quarto.js" type="module"></script>
3535
<script src="site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
36+
<script src="site_libs/quarto-html/axe/axe-check.js" type="module"></script>
3637
<script src="site_libs/quarto-html/popper.min.js"></script>
3738
<script src="site_libs/quarto-html/tippy.umd.min.js"></script>
3839
<script src="site_libs/quarto-html/anchor.min.js"></script>
3940
<link href="site_libs/quarto-html/tippy.css" rel="stylesheet">
40-
<link href="site_libs/quarto-html/quarto-syntax-highlighting-629432c7d29b615b3888e3cdfd62b7a9.css" rel="stylesheet" id="quarto-text-highlighting-styles">
41+
<link href="site_libs/quarto-html/quarto-syntax-highlighting-ebbede3f255f00f2ca408d38e0ffdffb.css" rel="stylesheet" id="quarto-text-highlighting-styles">
4142
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
4243
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
43-
<link href="site_libs/bootstrap/bootstrap-3095cb3133064099da2b6c1e837d828f.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
44+
<link href="site_libs/bootstrap/bootstrap-7a3eaccc783c981f11d47746ab14e9c5.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
4445
<script id="quarto-search-options" type="application/json">{
4546
"location": "navbar",
4647
"copy-button": false,
@@ -78,6 +79,8 @@
7879
<nav class="navbar navbar-expand-lg " data-bs-theme="dark">
7980
<div class="navbar-container container-fluid">
8081
<div class="navbar-brand-container mx-auto">
82+
<a href="./index.html" class="navbar-brand navbar-brand-logo">
83+
</a>
8184
<a class="navbar-brand" href="./index.html">
8285
<span class="navbar-title">pyobsplot</span>
8386
</a>
@@ -400,13 +403,14 @@ <h2 class="anchored" data-anchor-id="pyobsplot-0.1.3">pyobsplot 0.1.3</h2>
400403
e.clearSelection();
401404
}
402405
const getTextToCopy = function(trigger) {
403-
const codeEl = trigger.previousElementSibling.cloneNode(true);
404-
for (const childEl of codeEl.children) {
405-
if (isCodeAnnotation(childEl)) {
406-
childEl.remove();
407-
}
406+
const outerScaffold = trigger.parentElement.cloneNode(true);
407+
const codeEl = outerScaffold.querySelector('code');
408+
for (const childEl of codeEl.children) {
409+
if (isCodeAnnotation(childEl)) {
410+
childEl.remove();
408411
}
409-
return codeEl.innerText;
412+
}
413+
return codeEl.innerText;
410414
}
411415
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
412416
text: getTextToCopy

‎development.html‎

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
33

44
<meta charset="utf-8">
5-
<meta name="generator" content="quarto-1.7.32">
5+
<meta name="generator" content="quarto-1.8.25">
66

77
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
88

@@ -69,14 +69,15 @@
6969
<link href="./favicon.png" rel="icon" type="image/png">
7070
<script src="site_libs/quarto-html/quarto.js" type="module"></script>
7171
<script src="site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
72+
<script src="site_libs/quarto-html/axe/axe-check.js" type="module"></script>
7273
<script src="site_libs/quarto-html/popper.min.js"></script>
7374
<script src="site_libs/quarto-html/tippy.umd.min.js"></script>
7475
<script src="site_libs/quarto-html/anchor.min.js"></script>
7576
<link href="site_libs/quarto-html/tippy.css" rel="stylesheet">
76-
<link href="site_libs/quarto-html/quarto-syntax-highlighting-629432c7d29b615b3888e3cdfd62b7a9.css" rel="stylesheet" id="quarto-text-highlighting-styles">
77+
<link href="site_libs/quarto-html/quarto-syntax-highlighting-ebbede3f255f00f2ca408d38e0ffdffb.css" rel="stylesheet" id="quarto-text-highlighting-styles">
7778
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
7879
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
79-
<link href="site_libs/bootstrap/bootstrap-3095cb3133064099da2b6c1e837d828f.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
80+
<link href="site_libs/bootstrap/bootstrap-7a3eaccc783c981f11d47746ab14e9c5.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
8081
<script id="quarto-search-options" type="application/json">{
8182
"location": "navbar",
8283
"copy-button": false,
@@ -114,6 +115,8 @@
114115
<nav class="navbar navbar-expand-lg " data-bs-theme="dark">
115116
<div class="navbar-container container-fluid">
116117
<div class="navbar-brand-container mx-auto">
118+
<a href="./index.html" class="navbar-brand navbar-brand-logo">
119+
</a>
117120
<a class="navbar-brand" href="./index.html">
118121
<span class="navbar-title">pyobsplot</span>
119122
</a>
@@ -154,6 +157,10 @@
154157
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article page-navbar">
155158
<!-- sidebar -->
156159
<nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal quarto-sidebar-collapse-item sidebar-navigation floating overflow-auto">
160+
<div class="pt-lg-2 mt-2 text-left sidebar-header sidebar-header-stacked">
161+
<a href="./index.html" class="sidebar-logo-link">
162+
</a>
163+
</div>
157164
<div class="sidebar-menu-container">
158165
<ul class="list-unstyled mt-1">
159166
<li class="sidebar-item sidebar-item-section">
@@ -286,9 +293,9 @@ <h1 class="title">Development</h1>
286293
<section id="install-from-git" class="level2">
287294
<h2 class="anchored" data-anchor-id="install-from-git">Install from git</h2>
288295
<p>To install <code>pyobsplot</code> from git:</p>
289-
<div class="sourceCode" id="cb1"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pip</span> install git+https://github.com/juba/pyobsplot.git</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
296+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb1"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pip</span> install git+https://github.com/juba/pyobsplot.git</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
290297
<p>To install <code>pyobsplot</code> npm package from git:</p>
291-
<div class="sourceCode" id="cb2"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> install <span class="st">'https://gitpkg.now.sh/juba/pyobsplot/packages/pyobsplot-js?main'</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
298+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb2"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> install <span class="st">'https://gitpkg.now.sh/juba/pyobsplot/packages/pyobsplot-js?main'</span></span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
292299
</section>
293300
<section id="install-fom-source" class="level2">
294301
<h2 class="anchored" data-anchor-id="install-fom-source">Install fom source</h2>
@@ -307,41 +314,41 @@ <h2 class="anchored" data-anchor-id="install-fom-source">Install fom source</h2>
307314
<section id="widget-javascript-modification-and-bundling" class="level2">
308315
<h2 class="anchored" data-anchor-id="widget-javascript-modification-and-bundling">Widget JavaScript modification and bundling</h2>
309316
<p>Each time the widget JavaScript or CSS code is modified in the <code>js/</code> or <code>css/</code> directories, it must be bundled with one of the following commands in <code>pyobsplot</code>:</p>
310-
<div class="sourceCode" id="cb3"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Bundle only once</span></span>
317+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb3"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Bundle only once</span></span>
311318
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run bundle</span>
312319
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Bundle and watch for code change</span></span>
313-
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run watch</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
320+
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run watch</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
314321
<p>The result is put into <code>src/pyobsplot/static</code>.</p>
315322
</section>
316323
<section id="tests" class="level2">
317324
<h2 class="anchored" data-anchor-id="tests">Tests</h2>
318325
<p><code>pyobsplot</code> comes with three types of tests : Python test, JavaScript tests and Visual regression tests.</p>
319326
<p>To run Python tests, use:</p>
320-
<div class="sourceCode" id="cb4"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run test</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
327+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb4"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run test</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
321328
<p>To run JavaScript tests, use:</p>
322-
<div class="sourceCode" id="cb5"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run test <span class="at">--workspaces</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
329+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb5"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run test <span class="at">--workspaces</span></span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
323330
<p>Visual regression tests allow to test if generated plots stay the same. They use the <a href="https://github.com/jupyterlab/jupyterlab/tree/master/galata">galata</a> framework. To run them you first have to start a specific Jupyter instance with:</p>
324-
<div class="sourceCode" id="cb6"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run uistart</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
331+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb6"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run uistart</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
325332
<p>If you use visual regression tests for the first time, you have to generate reference images with:</p>
326-
<div class="sourceCode" id="cb7"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Create / update reference images</span></span>
327-
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run uitest:update</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
333+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb7"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Create / update reference images</span></span>
334+
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run uitest:update</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
328335
<p>After that, you can test that currently generated images are the same as the reference one with:</p>
329-
<div class="sourceCode" id="cb8"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Compare with reference images</span></span>
330-
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run uitest</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
336+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb8"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Compare with reference images</span></span>
337+
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a><span class="ex">npm</span> run uitest</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
331338
</section>
332339
<section id="debug-mode" class="level2">
333340
<h2 class="anchored" data-anchor-id="debug-mode">Debug mode</h2>
334341
<p>“Debug mode” outputs the computed JavaScript plot structure (the one passed to <code>Plot.plot</code>).</p>
335342
<p>To activate it, add <code>debug=True</code> when using <code>Plot.plot()</code> or when creating your plot generator object:</p>
336-
<div id="95e7870b" class="cell" data-execution_count="1">
337-
<div class="sourceCode cell-code" id="cb9"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a>op <span class="op">=</span> Obsplot(debug<span class="op">=</span><span class="va">True</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
343+
<div id="5dc6c6dd" class="cell" data-execution_count="1">
344+
<div class="code-copy-outer-scaffold"><div class="sourceCode cell-code" id="cb9"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a>op <span class="op">=</span> Obsplot(debug<span class="op">=</span><span class="va">True</span>)</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
338345
</div>
339346
<p>If using the <code>widget</code> renderer, debug output will be displayed in JavaScript console. With the <code>jsdom</code> renderer, it will be displayed directly in the notebook.</p>
340347
</section>
341348
<section id="documentation" class="level2">
342349
<h2 class="anchored" data-anchor-id="documentation">Documentation</h2>
343350
<p>To generate the documentation with Quarto:</p>
344-
<div class="sourceCode" id="cb10"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> run quarto render doc/</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
351+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb10"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> run quarto render doc/</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
345352
</section>
346353
<section id="maintenance-notes" class="level2">
347354
<h2 class="anchored" data-anchor-id="maintenance-notes">Maintenance notes</h2>
@@ -423,13 +430,14 @@ <h3 class="anchored" data-anchor-id="new-plot-versions">New Plot versions</h3>
423430
e.clearSelection();
424431
}
425432
const getTextToCopy = function(trigger) {
426-
const codeEl = trigger.previousElementSibling.cloneNode(true);
427-
for (const childEl of codeEl.children) {
428-
if (isCodeAnnotation(childEl)) {
429-
childEl.remove();
430-
}
433+
const outerScaffold = trigger.parentElement.cloneNode(true);
434+
const codeEl = outerScaffold.querySelector('code');
435+
for (const childEl of codeEl.children) {
436+
if (isCodeAnnotation(childEl)) {
437+
childEl.remove();
431438
}
432-
return codeEl.innerText;
439+
}
440+
return codeEl.innerText;
433441
}
434442
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
435443
text: getTextToCopy

0 commit comments

Comments
 (0)