updated examples and docs

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -505,6 +505,9 @@ def acyclic(self):
         """
         Returns true if the current node graph is acyclic.
 
+        See Also:
+            :meth:`NodeGraphQt.NodeGraph.set_acyclic`
+
         Returns:
             bool: true if acyclic (default: ``True``).
         """
@@ -514,6 +517,9 @@ def set_acyclic(self, mode=False):
         """
         Enable the node graph to be a acyclic graph. (default: ``False``)
 
+        See Also:
+            :meth:`NodeGraphQt.NodeGraph.acyclic`
+
         Args:
             mode (bool): true to enable acyclic.
         """

NodeGraphQt/base/node.py

@@ -232,12 +232,26 @@ def create_property(self, name, value, items=None, range=None,
         """
         Creates a custom property to the node.
 
+        Widget Types:
+            - :attr:`NodeGraphQt.constants.NODE_PROP`
+            - :attr:`NodeGraphQt.constants.NODE_PROP_QLABEL`
+            - :attr:`NodeGraphQt.constants.NODE_PROP_QLINEEDIT`
+            - :attr:`NodeGraphQt.constants.NODE_PROP_QTEXTEDIT`
+            - :attr:`NodeGraphQt.constants.NODE_PROP_QCOMBO`
+            - :attr:`NodeGraphQt.constants.NODE_PROP_QCHECKBOX`
+            - :attr:`NodeGraphQt.constants.NODE_PROP_QSPINBOX`
+            - :attr:`NodeGraphQt.constants.NODE_PROP_COLORPICKER`
+            - :attr:`NodeGraphQt.constants.NODE_PROP_SLIDER`
+
+        See Also:
+            :class:`NodeGraphQt.PropertiesBinWidget`
+
         Args:
             name (str): name of the property.
             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 flag to display in the properties bin.
+            widget_type (int): widget flag to display in the ``PropertiesBinWidget``
             tab (str): name of the widget tab to display in the properties bin.
         """
         self.model.add_property(name, value, items, range, widget_type, tab)
@@ -441,8 +455,13 @@ def icon(self):
 
     def add_combo_menu(self, name='', label='', items=None, tab=None):
         """
-        Create a custom property and embed a
-        :class:`PySide2.QtWidgets.QComboBox` widget into the node.
+        Creates a custom property with the :meth:`NodeObject.create_property`
+        function and embeds a :class:`PySide2.QtWidgets.QComboBox` widget
+        into the node.
+
+        Note:
+            The embedded widget is wired up to the :meth:`NodeObject.set_property`
+            function use this function to to update the widget.
 
         Args:
             name (str): name for the custom property.
@@ -460,8 +479,13 @@ def add_combo_menu(self, name='', label='', items=None, tab=None):
 
     def add_text_input(self, name='', label='', text='', tab=None):
         """
-        Create a custom property and embed a
-        :class:`PySide2.QtWidgets.QLineEdit` widget into the node.
+        Creates a custom property with the :meth:`NodeObject.create_property`
+        function and embeds a :class:`PySide2.QtWidgets.QLineEdit` widget
+        into the node.
+
+        Note:
+            The embedded widget is wired up to the :meth:`NodeObject.set_property`
+            function use this function to to update the widget.
 
         Args:
             name (str): name for the custom property.
@@ -477,8 +501,13 @@ def add_text_input(self, name='', label='', text='', tab=None):
 
     def add_checkbox(self, name='', label='', text='', state=False, tab=None):
         """
-        Create a custom property and embed a
-        :class:`PySide2.QtWidgets.QCheckBox` widget into the node.
+        Creates a custom property with the :meth:`NodeObject.create_property`
+        function and embeds a :class:`PySide2.QtWidgets.QCheckBox` widget
+        into the node.
+
+        Note:
+            The embedded widget is wired up to the :meth:`NodeObject.set_property`
+            function use this function to to update the widget.
 
         Args:
             name (str): name for the custom property.

docs/conf.py

@@ -210,4 +210,7 @@
 
 
 # -- Options for autodoc ----------------------------------------------------
-autodoc_member_order = 'groupwise'
+autodoc_member_order = 'groupwise'
+
+# -- Options for image link -------------------------------------------------
+html_scaled_image_link = False

docs/examples/ex_node.rst

@@ -4,7 +4,7 @@ Node Examples
 Creating Nodes
 **************
 
-| Creating is done simply by calling the :func:`NodeGraphQt.NodeGraph.create_node` function.
+| Creating a node is done by calling the :func:`NodeGraphQt.NodeGraph.create_node` function.
 | (`see example below` ``line: 22``)
 
 .. code-block:: python
@@ -38,6 +38,44 @@ Creating Nodes
         app.exec_()
 
 
+Embedding Widgets
+*****************
+
+The :meth:`NodeGraphQt.BaseNode` class allows you to embed widgets inside a node here's a
+example to simply embed a ``QComboBox`` widget when reimplementing the ``BaseNode``.
+
+.. code-block:: python
+    :linenos:
+
+    from NodeGraphQt import BaseNode
+
+    class MyListNode(BaseNode):
+
+        __identifier__ = 'com.chantasticvfx'
+        NODE_NAME = 'node'
+
+        def __init__(self):
+            super(MyListNode, self).__init__()
+
+            items = ['apples', 'bananas', 'pears', 'mangos', 'oranges']
+            self.add_combo_menu('my_list', 'My List', items)
+
+To you update the widget you can call the :meth:`NodeGraphQt.NodeObject.set_property` function.
+
+.. code-block:: python
+    :linenos:
+
+    node = MyListNode()
+    node.set_property('my_list', 'mangos')
+
+
+`functions for embedding widgets into a base node:`
+
+ - ``QComboBox``: :meth:`NodeGraphQt.BaseNode.add_combo_menu`
+ - ``QCheckBox``: :meth:`NodeGraphQt.BaseNode.add_checkbox`
+ - ``QLineEdit``: :meth:`NodeGraphQt.BaseNode.add_text_input`
+
+
 Connecting Nodes
 ****************
 
@@ -78,8 +116,8 @@ connecting nodes with the port objects:
         - :func:`NodeGraphQt.Port.disconnect_from`
 
 
-Widget Example
-**************
+Connecting a PropertiesBin
+**************************
 
 Here's an example where we subclass the ``NodeGraph`` and connect it up to a
 ``PropertiesBinWidget`` and have it show when a node is double clicked.

docs/nodes.rst

@@ -1,13 +1,8 @@
 Nodes
 #####
 
-.. image:: _images/screenshot.png
-    :width: 95%
-
-----
-
 .. toctree::
-    :caption: Contents
+    :caption: Node Classes
     :name: nodestoc
     :maxdepth: 2