docs update.

Author: jchanvfx

NodeGraphQt/base/menu.py

@@ -10,7 +10,17 @@ class NodeGraphMenu(object):
     """
     The ``NodeGraphMenu`` is the context menu triggered from the node graph.
 
-    This class is an abstraction layer for the QMenu object.
+    example to accessing the node graph context menu.
+
+    .. code-block:: python
+        :linenos:
+
+        from NodeGraphQt import NodeGraph
+
+        node_graph = NodeGraph()
+
+        # get the context menu for the node graph.
+        context_menu = node_graph.get_context_menu('graph')
     """
 
     def __init__(self, graph, qmenu):
@@ -135,19 +145,52 @@ class NodesMenu(NodeGraphMenu):
     """
     The ``NodesMenu`` is the context menu triggered from the nodes.
 
-    This class is an abstraction layer for the QMenu object.
-
     **Inherited from:** :class:`NodeGraphQt.NodeGraphMenu`
+
+    example for adding a command to the nodes context menu.
+
+    .. code-block:: python
+        :linenos:
+
+        from NodeGraphQt import BaseNode, NodeGraph
+
+        # example node.
+        class MyNode(BaseNode):
+
+            __identifier__ = 'com.chantasticvfx'
+            NODE_NAME = 'my node'
+
+            def __init__(self):
+                super(MyNode, self).__init__()
+                self.add_input('in')
+                self.add_output('out')
+
+        # create node graph.
+        node_graph = NodeGraph()
+
+        # register example node.
+        node_graph.register_node(MyNode)
+
+        # get the context menu for the nodes.
+        nodes_menu = node_graph.get_context_menu('nodes')
+
+        # create a command
+        def test_func(graph, node):
+            print('Clicked on node: {}'.format(node.name()))
+
+        nodes_menu.add_command('test',
+                               func=test_func,
+                               node_type='com.chantasticvfx.MyNode')
+
     """
 
-    def add_command(self, name, func=None, shortcut=None, node_type=None):
+    def add_command(self, name, func=None, node_type=None):
         """
         Re-implemented to add a command to the specified node type menu.
 
         Args:
             name (str): command name.
             func (function): command function eg. "func(``graph``, ``node``)".
-            shortcut (str): shotcut key.
             node_type (str): specified node type for the command.
 
         Returns:
@@ -168,8 +211,6 @@ def add_command(self, name, func=None, shortcut=None, node_type=None):
         action.graph = self._graph
         if LooseVersion(QtCore.qVersion()) >= LooseVersion('5.10'):
             action.setShortcutVisibleInContextMenu(True)
-        if shortcut:
-            action.setShortcut(shortcut)
         if func:
             action.executed.connect(func)
         qaction = node_menu.addAction(action)
@@ -178,7 +219,7 @@ def add_command(self, name, func=None, shortcut=None, node_type=None):
 
 class NodeGraphCommand(object):
     """
-    base class for a menu command.
+    Node graph menu command.
     """
 
     def __init__(self, graph, qaction):

NodeGraphQt/base/utils.py

@@ -8,6 +8,14 @@ def setup_context_menu(graph):
     """
     Sets up the node graphs context menu with some basic menus and commands.
 
+    .. code-block:: python
+        :linenos:
+
+        from NodeGraphQt import NodeGraph, setup_context_menu
+
+        graph = NodeGraph()
+        setup_context_menu(graph)
+
     Args:
         graph (NodeGraphQt.NodeGraph): node graph.
     """

docs/menu.rst

@@ -4,66 +4,56 @@ Menus
 .. image:: _images/menu_hotkeys.png
     :width: 50%
 
-The ``NodeGraphQt.setup_context_menu`` has a built in function that'll populate the node graphs context menu a few
-default menus and commands.
 
-.. code-block:: python
-    :linenos:
-
-    from NodeGraphQt import NodeGraph, setup_context_menu
-
-    graph = NodeGraph()
-    setup_context_menu(graph)
-
-example adding "Foo" menu to the node graphs context menu.
+Here's an example where we add a ``"Foo"`` menu and then a ``"Bar"`` command with
+the function ``my_test()`` registered.
 
 .. code-block:: python
     :linenos:
 
     from NodeGraphQt import NodeGraph
 
+    # test function.
+    def my_test(graph):
+        selected_nodes = graph.selected_nodes()
+        print('Number of nodes selected: {}'.format(len(selected_nodes)))
+
     # create node graph.
     graph = NodeGraph()
 
     # get the main context menu.
-    root_menu = graph.context_menu()
+    context_menu = node_graph.get_context_menu('graph')
 
     # add a menu called "Foo".
-    foo_menu = root_menu.add_menu('Foo')
-
-add "Bar" command to the "Foo" menu.
-
-.. code-block:: python
-    :linenos:
-    :lineno-start: 11
-
-    # test function.
-    def my_test():
-        print('Hello World')
+    foo_menu = context_menu.add_menu('Foo')
 
     # add "Bar" command to the "Foo" menu.
+    # we also assign a short cut key "Shift+t" for this example.
     foo_menu.add_command('Bar', my_test, 'Shift+t')
 
 ----
 
-.. autofunction:: NodeGraphQt.setup_context_menu
-    :noindex:
-
-
+The ``NodeGraphQt.setup_context_menu`` is a built in function that'll populate
+the node graphs context menu a few default menus and commands.
 
 
-Graph Menus
-***********
+.. autofunction:: NodeGraphQt.setup_context_menu
+    :noindex:
 
-Node graph menu.
 
+NodeGraph Menu
+**************
 
-----
+The context menu triggered from the node graph.
 
 .. autoclass:: NodeGraphQt.NodeGraphMenu
     :members:
 
-----
+
+Nodes Menu
+**********
+
+The context menu triggered from a node.
 
 .. autoclass:: NodeGraphQt.NodesMenu
     :members:
@@ -72,9 +62,5 @@ Node graph menu.
 Command
 *******
 
-Node graph menu command.
-
-----
-
 .. autoclass:: NodeGraphQt.NodeGraphCommand
     :members: