github action: auto build api docs

jchanvfx · Jan 19, 2024 · 35f45b9 · 35f45b9
1 parent fabd0e3
commit 35f45b9
Show file tree

Hide file tree

Showing 59 changed files with 99 additions and 77 deletions.
diff --git a/api/.doctrees/builtin_widgets/NodesPaletteWidget.doctree b/api/.doctrees/builtin_widgets/NodesPaletteWidget.doctree
diff --git a/api/.doctrees/builtin_widgets/NodesTreeWidget.doctree b/api/.doctrees/builtin_widgets/NodesTreeWidget.doctree
diff --git a/api/.doctrees/builtin_widgets/PropertiesBinWidget.doctree b/api/.doctrees/builtin_widgets/PropertiesBinWidget.doctree
diff --git a/api/.doctrees/constants.doctree b/api/.doctrees/constants.doctree
diff --git a/api/.doctrees/environment.pickle b/api/.doctrees/environment.pickle
diff --git a/api/.doctrees/examples/ex_menu.doctree b/api/.doctrees/examples/ex_menu.doctree
diff --git a/api/.doctrees/examples/ex_node.doctree b/api/.doctrees/examples/ex_node.doctree
diff --git a/api/.doctrees/examples/ex_overview.doctree b/api/.doctrees/examples/ex_overview.doctree
diff --git a/api/.doctrees/examples/ex_pipe.doctree b/api/.doctrees/examples/ex_pipe.doctree
diff --git a/api/.doctrees/examples/ex_port.doctree b/api/.doctrees/examples/ex_port.doctree
diff --git a/api/.doctrees/graphs/NodeGraph.doctree b/api/.doctrees/graphs/NodeGraph.doctree
diff --git a/api/.doctrees/graphs/SubGraph.doctree b/api/.doctrees/graphs/SubGraph.doctree
diff --git a/api/.doctrees/graphs/_index_graphs.doctree b/api/.doctrees/graphs/_index_graphs.doctree
diff --git a/api/.doctrees/host_apps/_index_apps.doctree b/api/.doctrees/host_apps/_index_apps.doctree
diff --git a/api/.doctrees/host_apps/ex_app_nuke.doctree b/api/.doctrees/host_apps/ex_app_nuke.doctree
diff --git a/api/.doctrees/host_apps/ex_app_silhouette.doctree b/api/.doctrees/host_apps/ex_app_silhouette.doctree
diff --git a/api/.doctrees/index.doctree b/api/.doctrees/index.doctree
diff --git a/api/.doctrees/menu.doctree b/api/.doctrees/menu.doctree
diff --git a/api/.doctrees/node_widgets.doctree b/api/.doctrees/node_widgets.doctree
diff --git a/api/.doctrees/nodes/BackdropNode.doctree b/api/.doctrees/nodes/BackdropNode.doctree
diff --git a/api/.doctrees/nodes/BaseNode.doctree b/api/.doctrees/nodes/BaseNode.doctree
diff --git a/api/.doctrees/nodes/GroupNode.doctree b/api/.doctrees/nodes/GroupNode.doctree
diff --git a/api/.doctrees/nodes/NodeObject.doctree b/api/.doctrees/nodes/NodeObject.doctree
diff --git a/api/.doctrees/nodes/PortNode.doctree b/api/.doctrees/nodes/PortNode.doctree
diff --git a/api/.doctrees/nodes/_index_nodes.doctree b/api/.doctrees/nodes/_index_nodes.doctree
diff --git a/api/.doctrees/port.doctree b/api/.doctrees/port.doctree
diff --git a/api/_static/documentation_options.js b/api/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.6.30',
+    VERSION: '0.6.31',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/api/builtin_widgets/NodesPaletteWidget.html b/api/builtin_widgets/NodesPaletteWidget.html
@@ -31,7 +31,7 @@
       }
       if (!userPreference) {localStorage.setItem('darkMode', mode)}
     </script>
-<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=7712798a"></script>
+<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d36afd93"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
 <script defer="" src="../_static/theme.8ffe40a2eae52cc22aaf.js"></script>
@@ -126,7 +126,7 @@
 <li class="toctree-l1"><a class="reference internal" href="NodesTreeWidget.html">NodesTreeWidget</a></li>
 </ul>
 <br/>
-<code style="font-size: 0.65rem;">NodeGraphQt - v0.6.30</code>
+<code style="font-size: 0.65rem;">NodeGraphQt - v0.6.31</code>
 </nav>
 </div>
 </div>

diff --git a/api/builtin_widgets/NodesTreeWidget.html b/api/builtin_widgets/NodesTreeWidget.html
@@ -30,7 +30,7 @@
       }
       if (!userPreference) {localStorage.setItem('darkMode', mode)}
     </script>
-<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=7712798a"></script>
+<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d36afd93"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
 <script defer="" src="../_static/theme.8ffe40a2eae52cc22aaf.js"></script>
@@ -125,7 +125,7 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">NodesTreeWidget</a></li>
 </ul>
 <br/>
-<code style="font-size: 0.65rem;">NodeGraphQt - v0.6.30</code>
+<code style="font-size: 0.65rem;">NodeGraphQt - v0.6.31</code>
 </nav>
 </div>
 </div>

diff --git a/api/builtin_widgets/PropertiesBinWidget.html b/api/builtin_widgets/PropertiesBinWidget.html
@@ -31,7 +31,7 @@
       }
       if (!userPreference) {localStorage.setItem('darkMode', mode)}
     </script>
-<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=7712798a"></script>
+<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d36afd93"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
 <script defer="" src="../_static/theme.8ffe40a2eae52cc22aaf.js"></script>
@@ -126,7 +126,7 @@
 <li class="toctree-l1"><a class="reference internal" href="NodesTreeWidget.html">NodesTreeWidget</a></li>
 </ul>
 <br/>
-<code style="font-size: 0.65rem;">NodeGraphQt - v0.6.30</code>
+<code style="font-size: 0.65rem;">NodeGraphQt - v0.6.31</code>
 </nav>
 </div>
 </div>
@@ -201,25 +201,28 @@ <h1>PropertiesBinWidget<a class="headerlink" href="#propertiesbinwidget" title="
 <p><strong>Methods:</strong></p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.limit" title="NodeGraphQt.PropertiesBinWidget.limit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">limit</span></code></a>()</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.create_property_editor" title="NodeGraphQt.PropertiesBinWidget.create_property_editor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_property_editor</span></code></a>(node)</p></td>
+<td><p>Creates a new property editor widget from the provided node.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.limit" title="NodeGraphQt.PropertiesBinWidget.limit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">limit</span></code></a>()</p></td>
 <td><p>Returns the limit for how many nodes can be loaded into the bin.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.set_limit" title="NodeGraphQt.PropertiesBinWidget.set_limit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_limit</span></code></a>(limit)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.set_limit" title="NodeGraphQt.PropertiesBinWidget.set_limit"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_limit</span></code></a>(limit)</p></td>
 <td><p>Set limit of nodes to display.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.add_node" title="NodeGraphQt.PropertiesBinWidget.add_node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_node</span></code></a>(node)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.add_node" title="NodeGraphQt.PropertiesBinWidget.add_node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_node</span></code></a>(node)</p></td>
 <td><p>Add node to the properties bin.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.remove_node" title="NodeGraphQt.PropertiesBinWidget.remove_node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_node</span></code></a>(node)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.remove_node" title="NodeGraphQt.PropertiesBinWidget.remove_node"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_node</span></code></a>(node)</p></td>
 <td><p>Remove node from the properties bin.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.lock_bin" title="NodeGraphQt.PropertiesBinWidget.lock_bin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lock_bin</span></code></a>()</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.lock_bin" title="NodeGraphQt.PropertiesBinWidget.lock_bin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lock_bin</span></code></a>()</p></td>
 <td><p>Lock/UnLock the properties bin.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.clear_bin" title="NodeGraphQt.PropertiesBinWidget.clear_bin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clear_bin</span></code></a>()</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.clear_bin" title="NodeGraphQt.PropertiesBinWidget.clear_bin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clear_bin</span></code></a>()</p></td>
 <td><p>Clear the properties bin.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.prop_widget" title="NodeGraphQt.PropertiesBinWidget.prop_widget"><code class="xref py py-obj docutils literal notranslate"><span class="pre">prop_widget</span></code></a>(node)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#NodeGraphQt.PropertiesBinWidget.prop_widget" title="NodeGraphQt.PropertiesBinWidget.prop_widget"><code class="xref py py-obj docutils literal notranslate"><span class="pre">prop_widget</span></code></a>(node)</p></td>
 <td><p>Returns the node property widget.</p></td>
 </tr>
 </tbody>
@@ -230,6 +233,23 @@ <h1>PropertiesBinWidget<a class="headerlink" href="#propertiesbinwidget" title="
 <dd><p>Signal emitted (node_id, prop_name, prop_value)</p>
 </dd></dl>
 <dl class="py method">
+<dt class="sig sig-object py" id="NodeGraphQt.PropertiesBinWidget.create_property_editor">
+<span class="sig-name descname"><span class="pre">create_property_editor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#NodeGraphQt.PropertiesBinWidget.create_property_editor" title="Permalink to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#NodeGraphQt.PropertiesBinWidget.create_property_editor'"><svg height="1em" viewbox="0 0 24 24" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"></path></svg></a></dt>
+<dd><p>Creates a new property editor widget from the provided node.</p>
+<p>(re-implement for displaying custom node property editor widget.)</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>node</strong> (<a class="reference internal" href="../nodes/NodeObject.html#NodeGraphQt.NodeObject" title="NodeGraphQt.NodeObject"><em>NodeGraphQt.NodeObject</em></a>) – node object.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>property editor widget.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>NodePropEditorWidget</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
 <dt class="sig sig-object py" id="NodeGraphQt.PropertiesBinWidget.limit">
 <span class="sig-name descname"><span class="pre">limit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#NodeGraphQt.PropertiesBinWidget.limit" title="Permalink to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#NodeGraphQt.PropertiesBinWidget.limit'"><svg height="1em" viewbox="0 0 24 24" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"></path></svg></a></dt>
 <dd><p>Returns the limit for how many nodes can be loaded into the bin.</p>

diff --git a/api/constants.html b/api/constants.html
@@ -31,7 +31,7 @@
       }
       if (!userPreference) {localStorage.setItem('darkMode', mode)}
     </script>
-<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=7712798a"></script>
+<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=d36afd93"></script>
 <script src="_static/doctools.js?v=888ff710"></script>
 <script src="_static/sphinx_highlight.js?v=4825356b"></script>
 <script defer="" src="_static/theme.8ffe40a2eae52cc22aaf.js"></script>
@@ -126,7 +126,7 @@
 <li class="toctree-l1"><a class="reference internal" href="builtin_widgets/NodesTreeWidget.html">NodesTreeWidget</a></li>
 </ul>
 <br/>
-<code style="font-size: 0.65rem;">NodeGraphQt - v0.6.30</code>
+<code style="font-size: 0.65rem;">NodeGraphQt - v0.6.31</code>
 </nav>
 </div>
 </div>
@@ -216,7 +216,7 @@
 </table>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="NodeGraphQt.constants.VersionEnum.VERSION">
-<span class="sig-name descname"><span class="pre">VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'0.6.30'</span></em><a class="headerlink" href="#NodeGraphQt.constants.VersionEnum.VERSION" title="Permalink to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#NodeGraphQt.constants.VersionEnum.VERSION'"><svg height="1em" viewbox="0 0 24 24" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"></path></svg></a></dt>
+<span class="sig-name descname"><span class="pre">VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'0.6.31'</span></em><a class="headerlink" href="#NodeGraphQt.constants.VersionEnum.VERSION" title="Permalink to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#NodeGraphQt.constants.VersionEnum.VERSION'"><svg height="1em" viewbox="0 0 24 24" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"></path></svg></a></dt>
 <dd><p>current version string.</p>
 </dd></dl>
 <dl class="py attribute">
@@ -231,7 +231,7 @@
 </dd></dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="NodeGraphQt.constants.VersionEnum.PATCH">
-<span class="sig-name descname"><span class="pre">PATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">30</span></em><a class="headerlink" href="#NodeGraphQt.constants.VersionEnum.PATCH" title="Permalink to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#NodeGraphQt.constants.VersionEnum.PATCH'"><svg height="1em" viewbox="0 0 24 24" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"></path></svg></a></dt>
+<span class="sig-name descname"><span class="pre">PATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">31</span></em><a class="headerlink" href="#NodeGraphQt.constants.VersionEnum.PATCH" title="Permalink to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#NodeGraphQt.constants.VersionEnum.PATCH'"><svg height="1em" viewbox="0 0 24 24" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"></path></svg></a></dt>
 <dd><p>version patch int.</p>
 </dd></dl>
 </dd></dl>