api doc updates.

jchanvfx · jchanvfx · commit 9940627bf97a · 2019-01-02T18:02:39.000+13:00
diff --git a/NodeGraphQt/base/actions.py b/NodeGraphQt/base/actions.py
@@ -9,7 +9,7 @@ def setup_context_menu(graph):
     Sets up the node graphs context menu with some basic menus and commands.
 
     Args:
-        graph (NodeGraphQt.NodeGraph): node graph controller class.
+        graph (NodeGraphQt.NodeGraph): node graph.
     """
     root_menu = graph.context_menu()
 
diff --git a/NodeGraphQt/base/menu.py b/NodeGraphQt/base/menu.py
@@ -40,7 +40,7 @@ def get_menu(self, name):
             name (str): name of the menu.
 
         Returns:
-            NodeGraphQt.base.menu.ContextMenu: menu item.
+            NodeGraphQt.ContextMenu: menu item.
         """
         for action in self.qmenu.actions():
             if action.menu() and action.menu().title() == name:
@@ -100,7 +100,7 @@ def add_command(self, name, func=None, shortcut=None):
 
         Args:
             name (str): command name.
-            func (): command function.
+            func (function): command function.
             shortcut (str): shotcut key.
 
         Returns:
diff --git a/NodeGraphQt/base/node.py b/NodeGraphQt/base/node.py
@@ -60,7 +60,7 @@ def __ne__(self, other):
     def type(cls):
         """
         Node type identifier followed by the class name.
-        eg. com.chantasticvfx.FooNode
+        eg. com.chantasticvfx.MyNode
 
         Returns:
             str: node type.
@@ -229,7 +229,7 @@ def create_property(self, name, value, items=None, range=None, widget_type=NODE_
             value (object): data.
             items (list[str]): items used by widget type NODE_PROP_QCOMBO
             range (tuple)): min, max values used by NODE_PROP_SLIDER
-            widget_type (int): widget type flag.
+            widget_type (int): widget type flag (not implemented yet).
         """
         self.model.add_property(name, value, items, range, widget_type)
 
diff --git a/NodeGraphQt/base/port.py b/NodeGraphQt/base/port.py
@@ -7,7 +7,7 @@
 
 class Port(object):
     """
-    base class for a :ref:`NodeGraphQt.Node` port.
+    base class for a :class:`NodeGraphQt.Node` port.
 
     Args:
         node (NodeGraphQt.NodeObject): parent node.
diff --git a/NodeGraphQt/base/vendor.py b/NodeGraphQt/base/vendor.py
@@ -3,7 +3,7 @@
 
 class NodeVendor(object):
     """
-    Node manager that stores all the node types.
+    Node factory that stores all the node types.
     """
 
     def __init__(self):
diff --git a/docs/connections.rst b/docs/connections.rst
@@ -1,13 +1,12 @@
 Port
 ****
 
-The ``NodeGraphQt.Port`` class is used for connecting one node to another.
+The ``Port`` class is used for connecting one node to another.
 
 .. image:: _images/port.png
     :width: 50%
 
-NodeGraphQt.Port
-================
+----
 
 .. autoclass:: NodeGraphQt.Port
     :members:
diff --git a/docs/graph.rst b/docs/graph.rst
@@ -1,19 +1,13 @@
-Graph
-*****
+Node Graph
+**********
+
+**Inherited from:** :class:`PySide2.QtCore.QObject`
 
 The NodeGraph class is the main controller for managing all nodes.
 
 .. image:: _images/graph.png
     :width: 60%
 
-
-NodeGraphQt.NodeGraph
-=====================
-
-
-**Inherited from:** `QtCore.QObject <https://doc.qt.io/qtforpython/PySide2/QtCore/QObject.html?highlight=qobject>`_
-
-
 ----
 
 .. autoclass:: NodeGraphQt.NodeGraph
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,8 @@
 NodeGraphQt API
 ***************
 
+Welcome to the ``NodeGraphQt`` api documentation and just like the project on GitHub this is also a work in progress.
+
 .. image:: _images/screenshot.png
     :width: 95%
 
@@ -14,68 +16,10 @@ Contents
     :maxdepth: 3
 
     overview
-    constants
     graph
     nodes
-    port
+    connections
     menu
-
-
-Example
-=======
-
-A basic example snippet.
-
-.. code-block:: python
-    :linenos:
-
-    import sys
-    from PySide2 import QtWidgets
-
-    from NodeGraphQt import NodeGraph, Node, setup_context_menu
-
-
-    class FooNode(Node):
-
-        # unique node identifier domain.
-        __identifier__ = 'com.chantasticvfx'
-
-        # initial default node name.
-        NODE_NAME = 'Foo Node'
-
-        def __init__(self):
-            super(FooNode, self).__init__()
-
-            # create an input port.
-            self.add_input('in')
-
-            # create an output port.
-            self.add_output('out')
-
-
-    if __name__ == '__main__':
-        app = QtWidgets.QApplication(sys.argv)
-
-        # create node graph controller.
-        graph = NodeGraph()
-
-        # set up default menu and commands.
-        setup_context_menu(graph)
-
-        # register the FooNode node class.
-        graph.register_node(FooNode)
-
-        # show the node graph widget.
-        viewer = graph.viewer()
-        viewer.show()
-
-        # create two nodes.
-        node_a = graph.create_node('com.chantasticvfx.FooNode', name='node A')
-        node_b = graph.create_node('com.chantasticvfx.FooNode', name='node B')
-
-        # connect node_a to node_b
-        node_a.set_output(0, node_b.input(2))
-
-        app.exec_()
+    constants
 
 
diff --git a/docs/menu.rst b/docs/menu.rst
@@ -1,7 +1,24 @@
 Menu & Commands
 ***************
 
-example to adding a menu and command.
+Default Setup
+=============
+
+The ``NodeGraphQt`` module has a built in ``setup_context_menu`` function that'll populate the node graphs
+context menu some default menus and commands.
+
+.. image:: _images/menu_hotkeys.png
+    :width: 50%
+
+----
+
+.. autofunction:: NodeGraphQt.setup_context_menu
+    :noindex:
+
+Example
+=======
+
+Here's a example to adding a menu and command.
 
 .. code-block:: python
     :linenos:
@@ -25,19 +42,8 @@ example to adding a menu and command.
     foo_menu.add_command('Bar', my_test_func, 'Shift+t')
 
 
-Default Setup
-=============
-
-The ``NodeGraphQt`` module has a built in ``setup_context_menu`` function that'll populate the node graphs
-context menu some default menus and commands.
-
-----
-
-.. autofunction:: NodeGraphQt.setup_context_menu
-
-
-ContextMenu
-===========
+Menu
+====
 
 Node graph context menu.
 
@@ -48,8 +54,8 @@ Node graph context menu.
     :members:
 
 
-ContextMenuCommand
-==================
+Command
+=======
 
 Node graph context menu command.
 
diff --git a/docs/nodes.rst b/docs/nodes.rst
@@ -2,13 +2,17 @@ Nodes
 *****
 
 
-NodeGraphQt.NodeObject
-======================
+Node Object
+===========
 
-**Inherited by:** :ref:`NodeGraphQt.Node`, :ref:`NodeGraphQt.Backdrop`
+**Inherited by:** :class:`NodeGraphQt.Node`, :class:`NodeGraphQt.Backdrop`
+
+The ``NodeObject`` class is the main base class that all nodes inherit from.
 
 ----
 
+.. note::
+    These two attributes require reimplementing when subclassing any node object.
 
 .. autoattribute:: NodeGraphQt.NodeObject.__identifier__
 .. autoattribute:: NodeGraphQt.NodeObject.NODE_NAME
@@ -21,11 +25,12 @@ NodeGraphQt.NodeObject
     :exclude-members: model, NODE_NAME
 
 
+Node
+====
 
-NodeGraphQt.Node
-================
+**Inherited from:** :class:`NodeGraphQt.NodeObject`
 
-**Inherited from:** :ref:`NodeGraphQt.NodeObject`
+The ``Node`` class is the base class for nodes that allows port connections from one node to another.
 
 
 .. image:: _images/node.png
@@ -38,10 +43,12 @@ NodeGraphQt.Node
     :exclude-members: update_model
 
 
-NodeGraphQt.Backdrop
-====================
+Backdrop
+========
+
+**Inherited from:** :class:`NodeGraphQt.NodeObject`
 
-**Inherited from:** :ref:`NodeGraphQt.NodeObject`
+The ``Backdrop`` class allows other node object to be nested inside, it's mainly good for grouping nodes together.
 
 .. image:: _images/backdrop.png
     :width: 250px
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -32,12 +32,12 @@ Node can be created with the tab node search widget.
 +-------------+--------+
 
 .. note::
-    To override the tab search widget hotkey see :ref:`NodeGraphQt.NodeGraph` class ``tab_search_key`` argument.
+    To override the tab search widget hotkey see :class:`NodeGraphQt.NodeGraph` class for the tab_search_key argument.
 
-Context Menu Setup
-==================
+Menu Setup
+==========
 
-The ``NodeGraphQt`` module has a built in ``setup_context_menu`` function that'll populate the node graphs
+The NodeGraphQt module has a built in :meth:`NodeGraphQt.setup_context_menu` method that'll help setup the node graphs
 context menu some default menus and commands.
 
 
@@ -48,4 +48,62 @@ see also: :ref:`Menu & Commands`
 
 ----
 
-.. autofunction:: NodeGraphQt.setup_context_menu
+.. autofunction:: NodeGraphQt.setup_context_menu
+
+
+Example
+=======
+
+A basic example snippet.
+
+.. code-block:: python
+    :linenos:
+
+    import sys
+    from PySide2 import QtWidgets
+
+    from NodeGraphQt import NodeGraph, Node, setup_context_menu
+
+
+    class FooNode(Node):
+
+        # unique node identifier domain.
+        __identifier__ = 'com.chantasticvfx'
+
+        # initial default node name.
+        NODE_NAME = 'Foo Node'
+
+        def __init__(self):
+            super(FooNode, self).__init__()
+
+            # create an input port.
+            self.add_input('in')
+
+            # create an output port.
+            self.add_output('out')
+
+
+    if __name__ == '__main__':
+        app = QtWidgets.QApplication(sys.argv)
+
+        # create node graph controller.
+        graph = NodeGraph()
+
+        # set up default menu and commands.
+        setup_context_menu(graph)
+
+        # register the FooNode node class.
+        graph.register_node(FooNode)
+
+        # show the node graph widget.
+        viewer = graph.viewer()
+        viewer.show()
+
+        # create two nodes.
+        node_a = graph.create_node('com.chantasticvfx.FooNode', name='node A')
+        node_b = graph.create_node('com.chantasticvfx.FooNode', name='node B')
+
+        # connect node_a to node_b
+        node_a.set_output(0, node_b.input(2))
+
+        app.exec_()
diff --git a/example.py b/example.py
@@ -39,8 +39,8 @@ def __init__(self):
     # set up default menu and commands.
     setup_context_menu(graph)
 
+    # viewer widget used for the node graph.
     viewer = graph.viewer()
-    viewer.setWindowTitle('My Node Graph')
     viewer.resize(1100, 800)
     viewer.show()
 
