Skip to content

Commit 8fcbd77

Browse files
committed
Update documentation
1 parent 15119fb commit 8fcbd77

File tree

257 files changed

+326
-278
lines changed

Some content is hidden

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

257 files changed

+326
-278
lines changed

en/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 1723f1908338e6cde316225cd85a16b6
3+
config: 079c064f4b64ad158df509a7fab911bf
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

en/.doctrees/api/algorithms.doctree

0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
1.78 KB
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

en/.doctrees/api/index.doctree

0 Bytes
Binary file not shown.

en/.doctrees/api/obj.doctree

0 Bytes
Binary file not shown.

en/.doctrees/api/param.doctree

0 Bytes
Binary file not shown.

en/.doctrees/api/proxy.doctree

0 Bytes
Binary file not shown.
9 KB
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

en/.doctrees/environment.pickle

11 KB
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
-816 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.

en/.doctrees/features/index.doctree

0 Bytes
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
0 Bytes
Binary file not shown.

en/.doctrees/index.doctree

0 Bytes
Binary file not shown.

en/.doctrees/intro/index.doctree

0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

en/.doctrees/requirements.doctree

0 Bytes
Binary file not shown.

en/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '0.16.2',
2+
VERSION: '0.16.3',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

en/api/algorithms.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../_static/doctools.js?v=888ff710"></script>
5555
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.computation.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../_static/doctools.js?v=888ff710"></script>
5555
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.gui/actionhandler.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.gui/docks.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.gui/h5io.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.gui/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.gui/main.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.gui/objectview.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.gui/panel.html

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

@@ -759,8 +759,13 @@
759759

760760
<dl class="py method">
761761
<dt class="sig sig-object py" id="cdl.core.gui.panel.base.BaseDataPanel.remove_object">
762-
<span class="sig-name descname"><span class="pre">remove_object</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#cdl.core.gui.panel.base.BaseDataPanel.remove_object" title="Link to this definition">#</a></dt>
762+
<span class="sig-name descname"><span class="pre">remove_object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#cdl.core.gui.panel.base.BaseDataPanel.remove_object" title="Link to this definition">#</a></dt>
763763
<dd><p>Remove signal/image object</p>
764+
<dl class="field-list simple">
765+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
766+
<dd class="field-odd"><p><strong>force</strong> – if True, remove object without confirmation. Defaults to False.</p>
767+
</dd>
768+
</dl>
764769
</dd></dl>
765770

766771
<dl class="py method">

en/api/core.gui/plothandler.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.gui/processor.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/core.gui/roieditor.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../../_static/doctools.js?v=888ff710"></script>
5555
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../_static/doctools.js?v=888ff710"></script>
5555
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/obj.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../_static/doctools.js?v=888ff710"></script>
5555
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/param.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../_static/doctools.js?v=888ff710"></script>
5555
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

en/api/proxy.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
5151
<script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>
5252

53-
<script src="../_static/documentation_options.js?v=7674c73b"></script>
53+
<script src="../_static/documentation_options.js?v=df34b35d"></script>
5454
<script src="../_static/doctools.js?v=888ff710"></script>
5555
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -148,7 +148,7 @@
148148
<script>document.write(`<img src="../_static/DataLab-Title.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
149149

150150

151-
<p class="title logo__title">v0.16.2</p>
151+
<p class="title logo__title">v0.16.3</p>
152152

153153
</a></div>
154154

0 commit comments

Comments
 (0)