docs clean up.

Author: jchanvfx

NodeGraphQt/base/node.py

@@ -22,24 +22,53 @@ class NodeObject(object):
 
     Args:
         qgraphics_item (AbstractNodeItem): QGraphicsItem item used for drawing.
-
-            .. code-block:: python
-
-                # snippet taken from the NodeGraphQt.BaseNode class.
-
-                class BaseNode(NodeObject):
-
-                    def __init__(self, qgraphics_item=None):
-                        qgraphics_item = qgraphics_item or NodeItem
-                        super(BaseNode, self).__init__(qgraphics_views)
-
     """
 
-    # Unique node identifier domain. `eg.` ``"io.github.jchanvfx"``
     __identifier__ = 'nodeGraphQt.nodes'
+    """
+    Unique node identifier domain. eg. ``"io.github.jchanvfx"``
+
+    .. important:: re-implement this attribute to provide a unique node type.
+    
+        .. code-block:: python
+            :linenos:
+    
+            from NodeGraphQt import NodeObject
+    
+            class ExampleNode(NodeObject):
+    
+                # unique node identifier domain.
+                __identifier__ = 'io.jchanvfx.github'
+    
+                def __init__(self):
+                    ...
+    
+    :return: node type domain.
+    :rtype: str
+    """
 
-    # Base node name.
     NODE_NAME = None
+    """
+    Initial base node name.
+
+    .. important:: re-implement this attribute to provide a base node name.
+    
+        .. code-block:: python
+            :linenos:
+    
+            from NodeGraphQt import NodeObject
+    
+            class ExampleNode(NodeObject):
+    
+                # initial default node name.
+                NODE_NAME = 'Example Node'
+    
+                def __init__(self):
+                    ...
+    
+    :return: node name
+    :rtype: str
+    """
 
     def __init__(self, qgraphics_item=None):
         """
@@ -71,10 +100,10 @@ def __repr__(self):
     def type_(cls):
         """
         Node type identifier followed by the class name.
-        `eg.` ``"com.chantacticvfx.NodeObject"``
+        `eg.` ``"nodeGraphQt.nodes.NodeObject"``
 
         Returns:
-            str: node type.
+            str: node type (``__identifier__.__className__``)
         """
         return cls.__identifier__ + '.' + cls.__name__
 
@@ -84,7 +113,7 @@ def id(self):
         The node unique id.
 
         Returns:
-            str: unique id string.
+            str: unique identifier string to the node.
         """
         return self.model.id
 
@@ -94,7 +123,7 @@ def graph(self):
         The parent node graph.
 
         Returns:
-            NodeGraphQt.NodeGraph: node graph.
+            NodeGraphQt.NodeGraph: node graph instance.
         """
         return self._graph
 

docs/conf.py

@@ -50,6 +50,7 @@
     'sphinx.ext.inheritance_diagram',
     'sphinx.ext.intersphinx',
     'sphinx.ext.napoleon',
+    'autodocsumm',
 ]
 
 intersphinx_mapping = {
@@ -69,6 +70,9 @@
     'NodeGraphQt.nodes.group_node.GroupNode': 'NodeGraphQt.GroupNode',
 }
 
+# autodocsumm options
+autodoc_default_options = {'autosummary': True}
+
 # order of members.
 autodoc_member_order = 'groupwise'
 

docs/graph.rst

@@ -10,12 +10,8 @@ NodeGraph
 
 .. autoclass:: NodeGraphQt.NodeGraph
     :members:
-    :exclude-members: model, widget
     :member-order: bysource
 
-    .. autoattribute:: NodeGraphQt.NodeGraph.widget
-    .. autoattribute:: NodeGraphQt.NodeGraph.model
-
 SubGraph
 ********
 

docs/host_apps/ex_app_nuke.rst

@@ -7,7 +7,7 @@ Creating a node graph widget in Nuke.
         :width: 800px
 
 | Here is an example where the :attr:`NodeGraphQt.NodeGraph.widget` can be
-registered as a panel in the compositing application NUKE.
+ registered as a panel in the compositing application NUKE.
 
 .. code-block:: python
     :linenos:

docs/host_apps/ex_app_silhouette.rst

@@ -12,7 +12,7 @@ Creating a node graph widget in Silhouette FX.
         :width: 800px
 
 | Here is an example where the :attr:`NodeGraphQt.NodeGraph.widget` can be
-registered as a dockable panel in the application .
+ registered as a dockable panel in the application .
 
 .. code-block:: python
     :linenos:

docs/nodes/NodeObject.rst

@@ -3,38 +3,6 @@ NodeObject
 
 .. autoclass:: NodeGraphQt.NodeObject
     :members:
-    :exclude-members: NODE_NAME, graph, id, model, type_, view
     :member-order: bysource
 
-    .. autoattribute:: NODE_NAME
-        :annotation:
-
-        Initial base node name.
-
-        .. important:: re-implement this attribute to provide a base node name.
-
-        :return: node name
-        :rtype: str
-
     .. autoattribute:: __identifier__
-        :annotation:
-
-        Unique node identifier domain. eg. ``"nodeGraphQt.nodes"``
-
-        .. important:: re-implement this attribute to provide a unique node type.
-
-        :return: node identifier domain
-        :rtype: str
-
-    .. autoattribute:: graph
-    .. autoattribute:: id
-    .. autoattribute:: model
-    .. autoattribute:: type_
-        :annotation:
-
-        Node type identifier followed by the class name (<identifier>.<class_name>). `eg.` ``"nodeGraphQt.nodes.NodeObject"``
-
-        :return: node type (``__identifier__.__className__``)
-        :rtype: str
-
-    .. autoattribute:: view