updated docs and clean up

jchanvfx · jchanvfx · commit 0e68001c3dc8 · 2022-05-19T17:24:42.000+12:00
diff --git a/NodeGraphQt/base/graph_actions.py b/NodeGraphQt/base/graph_actions.py
@@ -230,8 +230,8 @@ def _expand_group_node(graph):
     Expand selected group node.
     """
     selected_nodes = graph.selected_nodes()
-    if len(selected_nodes) > 1:
-        graph.message_dialog('Please select a single "GroupNode" to expand.')
+    if not selected_nodes:
+        graph.message_dialog('Please select a "GroupNode" to expand.')
         return
     graph.expand_group_node(selected_nodes[0])
 
diff --git a/docs/_images/app_silhouette_example.png b/docs/_images/app_silhouette_example.png
diff --git a/docs/examples/ex_menu.rst b/docs/examples/ex_menu.rst
@@ -1,4 +1,4 @@
-Menu Examples
+Menu Overview
 #############
 
 Examples for customizing context menus in NodeGraphQt.
diff --git a/docs/examples/ex_node.rst b/docs/examples/ex_node.rst
@@ -1,4 +1,4 @@
-Node Examples
+Node Overview
 #############
 
 Creating Nodes
@@ -77,7 +77,7 @@ To you update the widget you can call the :meth:`NodeGraphQt.NodeObject.set_prop
  - ``QCheckBox``: :meth:`NodeGraphQt.BaseNode.add_checkbox`
  - ``QLineEdit``: :meth:`NodeGraphQt.BaseNode.add_text_input`
 
-See: :ref:`Node Embedded Widgets` for more node widget types.
+See: :ref:`Embedded Node Widgets` for more node widget types.
 
 Embedding Custom Widgets
 ************************
diff --git a/docs/examples/ex_overview.rst b/docs/examples/ex_overview.rst
@@ -1,5 +1,5 @@
-Basic Overview
-##############
+General Overview
+################
 
 User interface overview for the node graph.
 
@@ -54,8 +54,8 @@ Connection pipes can be disconnected easily with the built in slice tool.
 +---------------------+----------------------------+
 
 
-Simple Example
-**************
+Getting Started
+***************
 
 Here's a basic example snippet for creating two nodes and connecting them together.
 
diff --git a/docs/examples/ex_pipe.rst b/docs/examples/ex_pipe.rst
@@ -1,8 +1,8 @@
-Pipe Examples
+Pipe Overview
 #############
 
-Example Pipe Layouts
-********************
+Pipe Layouts
+************
 
 .. image:: ../_images/pipe_layout_types.gif
         :width: 650px
diff --git a/docs/examples/ex_port.rst b/docs/examples/ex_port.rst
@@ -1,4 +1,4 @@
-Port Examples
+Port Overview
 #############
 
 Creating Custom Shapes
diff --git a/docs/graph.rst b/docs/graph.rst
@@ -4,7 +4,7 @@ Graphs
 NodeGraph
 *********
 
-`See` :ref:`Simple Example` `from the NodeGraph overview.`
+`See` :ref:`Getting Started` `from the overview section.`
 
 ----
 
diff --git a/docs/host_apps/_index_apps.rst b/docs/host_apps/_index_apps.rst
@@ -0,0 +1,13 @@
+Host Application Examples
+#########################
+
+| Examples for implementing the NodeGraphQt framework in a host application.
+
+.. toctree::
+    :caption: Applications
+    :name: appstoc
+    :maxdepth: 2
+
+    ex_app_nuke
+    ex_app_silhouette
+
diff --git a/docs/host_apps/ex_app_nuke.rst b/docs/host_apps/ex_app_nuke.rst
@@ -1,15 +1,13 @@
-NodeGraphQt in Nuke
-###################
+Nuke
+####
 
-Creating a custom node graph panel in NUKE
+Creating a node graph widget in Nuke.
 
 .. image:: ../_images/app_nuke_example.png
         :width: 800px
 
-Here is an example where the :attr:`NodeGraph.widget` can be registered as a
-panel in the compositing application NUKE.
-
----
+| Here is an example where the :attr:`NodeGraph.widget` can be registered as a
+ panel in the compositing application NUKE.
 
 .. code-block:: python
     :linenos:
@@ -22,9 +20,6 @@ panel in the compositing application NUKE.
 
     # create a simple test node class.
     class TestNode(BaseNode):
-        """
-        Simple test node object.
-        """
 
         __identifier__ = 'nodes.nuke'
         NODE_NAME = 'test node'
@@ -59,9 +54,6 @@ panel in the compositing application NUKE.
 
     # create the wrapper widget.
     class CustomNodeGraph(QtWidgets.QWidget):
-        """
-        Custom node graph widget to be registered as a panel in Nuke.
-        """
 
         def __init__(self, parent=None):
             super(CustomNodeGraph, self).__init__(parent)
diff --git a/docs/host_apps/ex_app_silhouette.rst b/docs/host_apps/ex_app_silhouette.rst
@@ -0,0 +1,61 @@
+Silhouette
+##########
+
+Creating a node graph widget in Silhouette FX.
+
+.. image:: ../_images/app_silhouette_example.png
+        :width: 800px
+
+| Here is an example where the :attr:`NodeGraph.widget` can be registered as a
+ dockable panel in the application .
+
+.. code-block:: python
+    :linenos:
+
+    import fx
+
+    from Qt import QtWidgets, QtCore
+    from NodeGraphQt import NodeGraph, BaseNode
+
+
+    # create the widget wrapper that can be docked to the main window.
+    class NodeGraphPanel(QtWidgets.QDockWidget):
+        """
+        Widget wrapper for the node graph that can be docked to
+        the main window.
+        """
+
+        def __init__(self, graph, parent=None):
+            super(NodeGraphPanel, self).__init__(parent)
+            self.setObjectName('nodeGraphQt.NodeGraphPanel')
+            self.setWindowTitle('Custom Node Graph')
+            self.setWidget(graph.widget)
+
+
+    # create a simple test node class.
+    class TestNode(BaseNode):
+
+        __identifier__ = 'nodes.silhouettefx'
+        NODE_NAME = 'test node'
+
+        def __init__(self):
+            super(TestNode, self).__init__()
+            self.add_input('in')
+            self.add_output('out')
+
+
+    # create the node graph controller and register our "TestNode"
+    graph = NodeGraph()
+    graph.register_node(TestNode)
+
+    # create nodes.
+    node_1 = graph.create_node('nodes.silhouette.TestNode')
+    node_2 = graph.create_node('nodes.silhouette.TestNode')
+    node_3 = graph.create_node('nodes.silhouette.TestNode')
+
+    # create the node graph panel that can be docked.
+    sfx_graph_panel = NodeGraphPanel(graph)
+
+    # add the doc widget into the main silhouette window.
+    sfx_window = fx.ui.mainWindow()
+    sfx_window.addDockWidget(QtCore.Qt.RightDockWidgetArea, sfx_graph_panel)
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,25 +15,25 @@ https://github.com/jchanvfx/NodeGraphQt
 
     constants
     graph
-    nodes
+    nodes/_index_nodes
     menu
 
 .. toctree::
     :caption: Widgets
     :name: wdgtstoc
-    :maxdepth: 2
+    :maxdepth: 1
 
     custom_widgets
     node_widgets
 
 .. toctree::
     :caption: Examples
     :name: exmplstoc
-    :maxdepth: 3
+    :maxdepth: 1
 
     examples/ex_overview
     examples/ex_node
     examples/ex_port
     examples/ex_pipe
     examples/ex_menu
-    examples/ex_app_nuke
+    host_apps/_index_apps
diff --git a/docs/node_widgets.rst b/docs/node_widgets.rst
@@ -1,10 +1,11 @@
-Node Embedded Widgets
+Embedded Node Widgets
 #####################
 
-Node embedded widgets are the widgets that can be embedded into a
-:class:`NodeGraphQt.BaseNode` and displayed in the node graph.
+| Node embedded widgets are the widgets that can be embedded into a
+ :class:`NodeGraphQt.BaseNode` and displayed in the node graph.
 
-See :ref:`Embedding Custom Widgets` example to adding your own widget into a node.
+| To add you own widget in a node see the
+ :ref:`Embedding Custom Widgets` example.
 
 NodeBaseWidget
 **************
diff --git a/docs/nodes.rst b/docs/nodes.rst
diff --git a/docs/nodes/_index_nodes.rst b/docs/nodes/_index_nodes.rst
@@ -0,0 +1,16 @@
+Nodes
+#####
+
+| Node object types from the NodeGraphQt module.
+
+.. toctree::
+    :caption: Node Classes
+    :name: nodestoc
+    :maxdepth: 2
+
+    Port
+    NodeObject
+    BaseNode
+    GroupNode
+    PortNode
+    BackdropNode

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Menu Examples`
	`1`	`+Menu Overview`
`2`	`2`	`#############`
`3`	`3`
`4`	`4`	`Examples for customizing context menus in NodeGraphQt.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Port Examples`
	`1`	`+Port Overview`
`2`	`2`	`#############`
`3`	`3`
`4`	`4`	`Creating Custom Shapes`