github action: auto build api docs

jchanvfx · Sep 13, 2023 · e07c129 · e07c129
1 parent e132513
commit e07c129
Show file tree

Hide file tree

Showing 70 changed files with 3,993 additions and 323 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/_images/inheritance-d055f47861f9d76437232dfffd623c1916df57f3.png b/api/_images/inheritance-d055f47861f9d76437232dfffd623c1916df57f3.png
diff --git a/api/_images/inheritance-d055f47861f9d76437232dfffd623c1916df57f3.png.map b/api/_images/inheritance-d055f47861f9d76437232dfffd623c1916df57f3.png.map
@@ -0,0 +1,5 @@
+<map id="inheritance146860d3fa" name="inheritance146860d3fa">
+<area shape="rect" id="node1" href="NodeGraph.html#NodeGraphQt.NodeGraph" target="_top" title="The ``NodeGraph`` class is the main controller for managing all nodes" alt="" coords="232,5,419,31"/>
+<area shape="rect" id="node3" href="#NodeGraphQt.SubGraph" target="_top" title="The ``SubGraph`` class is just like the ``NodeGraph`` but is the main" alt="" coords="467,5,644,31"/>
+<area shape="rect" id="node2" title="QObject(self, parent: typing.Optional[PySide2.QtCore.QObject] = None) &#45;&gt; None" alt="" coords="5,5,184,31"/>
+</map>
diff --git a/api/_sources/builtin_widgets/NodesPaletteWidget.rst.txt b/api/_sources/builtin_widgets/NodesPaletteWidget.rst.txt
@@ -0,0 +1,11 @@
+:hide-rtoc:
+
+NodesPaletteWidget
+##################
+
+.. autosummary::
+    NodeGraphQt.NodesPaletteWidget
+
+.. autoclass:: NodeGraphQt.NodesPaletteWidget
+    :members:
+    :exclude-members: mimeData, staticMetaObject
diff --git a/api/_sources/builtin_widgets/NodesTreeWidget.rst.txt b/api/_sources/builtin_widgets/NodesTreeWidget.rst.txt
@@ -0,0 +1,11 @@
+:hide-rtoc:
+
+NodesTreeWidget
+###############
+
+.. autosummary::
+    NodeGraphQt.NodesTreeWidget
+
+.. autoclass:: NodeGraphQt.NodesTreeWidget
+    :members:
+    :exclude-members: mimeData, staticMetaObject
diff --git a/api/_sources/builtin_widgets/PropertiesBinWidget.rst.txt b/api/_sources/builtin_widgets/PropertiesBinWidget.rst.txt
@@ -0,0 +1,11 @@
+:hide-rtoc:
+
+PropertiesBinWidget
+###################
+
+.. autosummary::
+    NodeGraphQt.PropertiesBinWidget
+
+.. autoclass:: NodeGraphQt.PropertiesBinWidget
+    :members:
+    :exclude-members: staticMetaObject
diff --git a/api/_sources/examples/ex_node.rst.txt b/api/_sources/examples/ex_node.rst.txt
@@ -79,7 +79,7 @@ To you update the widget you can call the
  - ``QCheckBox``: :meth:`NodeGraphQt.BaseNode.add_checkbox`
  - ``QLineEdit``: :meth:`NodeGraphQt.BaseNode.add_text_input`
 
-See: :ref:`Node Widgets` for more node widget types.
+See: :ref:`Embedded Node Widgets` for more node widget types.
 
 |
 

diff --git a/api/_sources/graphs/NodeGraph.rst.txt b/api/_sources/graphs/NodeGraph.rst.txt
@@ -0,0 +1,30 @@
+:hide-rtoc:
+
+NodeGraph
+#########
+
+.. autosummary::
+    NodeGraphQt.NodeGraph
+
+.. code-block:: python
+    :linenos:
+
+    from Qt import QtWidgets
+    from NodeGraphQt import NodeGraph
+
+    if __name__ == '__main__':
+        app = QtWidgets.QApplication([])
+
+        node_graph = NodeGraph()
+
+        widget = node_graph.widget
+        widget.show()
+
+        app.exec_()
+
+---
+
+.. autoclass:: NodeGraphQt.NodeGraph
+    :members:
+    :member-order: bysource
+    :exclude-members: staticMetaObject
diff --git a/api/_sources/graphs/SubGraph.rst.txt b/api/_sources/graphs/SubGraph.rst.txt
@@ -0,0 +1,11 @@
+:hide-rtoc:
+
+SubGraph
+########
+
+.. autosummary::
+    NodeGraphQt.SubGraph
+
+.. autoclass:: NodeGraphQt.SubGraph
+    :members:
+    :exclude-members: staticMetaObject, delete_node, delete_nodes, is_root, sub_graphs, widget
diff --git a/api/_sources/graphs/_index_graphs.rst.txt b/api/_sources/graphs/_index_graphs.rst.txt
@@ -0,0 +1,14 @@
+Graphs
+######
+
+`See` :ref:`Getting Started` `from the overview section.`
+
+
+.. toctree::
+    :caption: Graph Classes
+    :name: graphstoc
+    :maxdepth: 2
+    :titlesonly:
+
+    NodeGraph
+    SubGraph
diff --git a/api/_sources/index.rst.txt b/api/_sources/index.rst.txt
@@ -53,7 +53,7 @@ script or checkout the :ref:`General Overview` section.
     :titlesonly:
 
     constants
-    graph
+    graphs/_index_graphs
     nodes/_index_nodes
     port
     menu
@@ -64,5 +64,7 @@ script or checkout the :ref:`General Overview` section.
     :name: wdgtstoc
     :maxdepth: 2
 
-    custom_widgets
     node_widgets
+    builtin_widgets/PropertiesBinWidget
+    builtin_widgets/NodesPaletteWidget
+    builtin_widgets/NodesTreeWidget
diff --git a/api/_sources/node_widgets.rst.txt b/api/_sources/node_widgets.rst.txt
@@ -1,11 +1,12 @@
 :hide-rtoc:
 
-Node Widgets
-############
+Embedded Node Widgets
+#####################
 
-| Node widgets are the widgets that can be embedded into a
+| Embedded node widgets are the widgets that can be embedded into a
   :class:`NodeGraphQt.BaseNode` and displayed in the node graph.
 
+|
 | To create your own widget embedded in a node see the
   :ref:`Embedding Custom Widgets` example page.
 

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.22',
+    VERSION: '0.6.23',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/api/builtin_widgets/NodesPaletteWidget.html b/api/builtin_widgets/NodesPaletteWidget.html
diff --git a/api/builtin_widgets/NodesTreeWidget.html b/api/builtin_widgets/NodesTreeWidget.html
diff --git a/api/builtin_widgets/PropertiesBinWidget.html b/api/builtin_widgets/PropertiesBinWidget.html
diff --git a/api/constants.html b/api/constants.html
diff --git a/api/custom_widgets.html b/api/custom_widgets.html
@@ -102,7 +102,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="constants.html">Constants</a></li>
 <li class="toctree-l1"><a class="reference internal" href="graph.html">Graphs</a></li>
-<li class="toctree-l1" x-data="{ expanded: $el.classList.contains('current') ? true : false }"><a :class="{ 'expanded' : expanded }" @click="expanded = !expanded" class="reference internal expandable" href="nodes/_index_nodes.html">Nodes<button @click.prevent.stop="expanded = !expanded" type="button"><span class="sr-only"></span><svg fill="currentColor" height="18px" stroke="none" viewbox="0 0 24 24" width="18px" xmlns="http://www.w3.org/2000/svg"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"></path></svg></button></a><ul x-show="expanded">
+<li class="toctree-l1" x-data="{ expanded: $el.classList.contains('current') ? true : false }"><a :class="{ 'expanded' : expanded }" @click="expanded = !expanded" class="reference internal expandable expandable" href="nodes/_index_nodes.html">Nodes<button @click.prevent.stop="expanded = !expanded" type="button"><span class="sr-only"></span><svg fill="currentColor" height="18px" stroke="none" viewbox="0 0 24 24" width="18px" xmlns="http://www.w3.org/2000/svg"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"></path></svg></button><button @click.prevent.stop="expanded = !expanded" type="button"><span class="sr-only"></span><svg fill="currentColor" height="18px" stroke="none" viewbox="0 0 24 24" width="18px" xmlns="http://www.w3.org/2000/svg"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"></path></svg></button></a><ul x-show="expanded">
 <li class="toctree-l2"><a class="reference internal" href="nodes/NodeObject.html">NodeObject</a></li>
 <li class="toctree-l2"><a class="reference internal" href="nodes/BackdropNode.html">BackdropNode</a></li>
 <li class="toctree-l2"><a class="reference internal" href="nodes/BaseNode.html">BaseNode</a></li>

diff --git a/api/examples/ex_menu.html b/api/examples/ex_menu.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=805da7bd"></script>
+<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=242523a4"></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>
@@ -101,7 +101,11 @@
 <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../constants.html">Constants</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../graph.html">Graphs</a></li>
+<li class="toctree-l1" x-data="{ expanded: $el.classList.contains('current') ? true : false }"><a :class="{ 'expanded' : expanded }" @click="expanded = !expanded" class="reference internal expandable" href="../graphs/_index_graphs.html">Graphs<button @click.prevent.stop="expanded = !expanded" type="button"><span class="sr-only"></span><svg fill="currentColor" height="18px" stroke="none" viewbox="0 0 24 24" width="18px" xmlns="http://www.w3.org/2000/svg"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"></path></svg></button></a><ul x-show="expanded">
+<li class="toctree-l2"><a class="reference internal" href="../graphs/NodeGraph.html">NodeGraph</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../graphs/SubGraph.html">SubGraph</a></li>
+</ul>
+</li>
 <li class="toctree-l1" x-data="{ expanded: $el.classList.contains('current') ? true : false }"><a :class="{ 'expanded' : expanded }" @click="expanded = !expanded" class="reference internal expandable" href="../nodes/_index_nodes.html">Nodes<button @click.prevent.stop="expanded = !expanded" type="button"><span class="sr-only"></span><svg fill="currentColor" height="18px" stroke="none" viewbox="0 0 24 24" width="18px" xmlns="http://www.w3.org/2000/svg"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z"></path></svg></button></a><ul x-show="expanded">
 <li class="toctree-l2"><a class="reference internal" href="../nodes/NodeObject.html">NodeObject</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../nodes/BackdropNode.html">BackdropNode</a></li>
@@ -116,11 +120,13 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Widgets</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../custom_widgets.html">Built-in Widgets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../node_widgets.html">Node Widgets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../node_widgets.html">Embedded Node Widgets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../builtin_widgets/PropertiesBinWidget.html">PropertiesBinWidget</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../builtin_widgets/NodesPaletteWidget.html">NodesPaletteWidget</a></li>
+<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.22</code>
+<code style="font-size: 0.65rem;">NodeGraphQt - v0.6.23</code>
 </nav>
 </div>
 </div>
@@ -149,10 +155,10 @@ <h1>Menu Overview<a class="headerlink" href="#menu-overview" title="Permalink to
 </div>
 <section id="default-context-menu">
 <h2>Default Context Menu<a class="headerlink" href="#default-context-menu" title="Permalink to this heading" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#default-context-menu'"><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></h2>
-<p>The <a class="reference internal" href="../graph.html#NodeGraphQt.NodeGraph" title="NodeGraphQt.NodeGraph"><code class="xref py py-class docutils literal notranslate"><span class="pre">NodeGraphQt.NodeGraph</span></code></a> has a context menu can be accessed with
-<a class="reference internal" href="../graph.html#NodeGraphQt.NodeGraph.context_menu" title="NodeGraphQt.NodeGraph.context_menu"><code class="xref py py-meth docutils literal notranslate"><span class="pre">NodeGraph.context_menu()</span></code></a>.</p>
+<p>The <a class="reference internal" href="../graphs/NodeGraph.html#NodeGraphQt.NodeGraph" title="NodeGraphQt.NodeGraph"><code class="xref py py-class docutils literal notranslate"><span class="pre">NodeGraphQt.NodeGraph</span></code></a> has a context menu can be accessed with
+<a class="reference internal" href="../graphs/NodeGraph.html#NodeGraphQt.NodeGraph.context_menu" title="NodeGraphQt.NodeGraph.context_menu"><code class="xref py py-meth docutils literal notranslate"><span class="pre">NodeGraph.context_menu()</span></code></a>.</p>
 <p>It can also be populated it with a config file in <code class="docutils literal notranslate"><span class="pre">JSON</span></code> format by using
-<a class="reference internal" href="../graph.html#NodeGraphQt.NodeGraph.set_context_menu_from_file" title="NodeGraphQt.NodeGraph.set_context_menu_from_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">NodeGraph.set_context_menu_from_file()</span></code></a>.</p>
+<a class="reference internal" href="../graphs/NodeGraph.html#NodeGraphQt.NodeGraph.set_context_menu_from_file" title="NodeGraphQt.NodeGraph.set_context_menu_from_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">NodeGraph.set_context_menu_from_file()</span></code></a>.</p>
 <img alt="../_images/menu_hotkeys.png" src="../_images/menu_hotkeys.png" style="width: 300px;"/>
 <div class="line-block">
 <div class="line">Here’s a couple links to the example config file and functions with a few essential menu commands.</div>
@@ -299,7 +305,7 @@ <h2>Adding with Config files<a class="headerlink" href="#adding-with-config-file
 </pre></div>
 </div>
 <p>In the main code where your node graph controller is defined we can just call the
-<a class="reference internal" href="../graph.html#NodeGraphQt.NodeGraph.set_context_menu_from_file" title="NodeGraphQt.NodeGraph.set_context_menu_from_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">NodeGraph.set_context_menu_from_file()</span></code></a></p>
+<a class="reference internal" href="../graphs/NodeGraph.html#NodeGraphQt.NodeGraph.set_context_menu_from_file" title="NodeGraphQt.NodeGraph.set_context_menu_from_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">NodeGraph.set_context_menu_from_file()</span></code></a></p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kn">from</span> <span class="nn">NodeGraphQt</span> <span class="kn">import</span> <span class="n">NodeGraph</span>
 <span class="linenos">2</span>
 <span class="linenos">3</span><span class="n">node_graph</span> <span class="o">=</span> <span class="n">NodeGraph</span><span class="p">()</span>
@@ -315,7 +321,7 @@ <h2>Adding with Config files<a class="headerlink" href="#adding-with-config-file
 <section id="adding-with-serialized-data">
 <h2>Adding with Serialized data<a class="headerlink" href="#adding-with-serialized-data" title="Permalink to this heading" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#adding-with-serialized-data'"><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></h2>
 <p>Alternatively if you do not prefer to have <code class="docutils literal notranslate"><span class="pre">json</span></code> config files the node graph also has a
-<a class="reference internal" href="../graph.html#NodeGraphQt.NodeGraph.set_context_menu" title="NodeGraphQt.NodeGraph.set_context_menu"><code class="xref py py-meth docutils literal notranslate"><span class="pre">NodeGraph.set_context_menu()</span></code></a> function.</p>
+<a class="reference internal" href="../graphs/NodeGraph.html#NodeGraphQt.NodeGraph.set_context_menu" title="NodeGraphQt.NodeGraph.set_context_menu"><code class="xref py py-meth docutils literal notranslate"><span class="pre">NodeGraph.set_context_menu()</span></code></a> function.</p>
 <p>here’s an example.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kn">from</span> <span class="nn">NodeGraphQt</span> <span class="kn">import</span> <span class="n">NodeGraph</span>
 <span class="linenos"> 2</span>