docs clean up

Author: jchanvfx

NodeGraphQt/nodes/port_node.py

@@ -39,7 +39,8 @@ def parent_port(self):
     def add_input(self, name='input', multi_input=False, display_name=True,
                   color=None, locked=False, painter_func=None):
         """
-        This is not available for the `PortInputNode` class.
+        Warnings:
+            This is not available for the ``PortInputNode`` class.
         """
         raise PortRegistrationError(
             '"{}.add_input()" is not available for {}.'
@@ -48,6 +49,11 @@ def add_input(self, name='input', multi_input=False, display_name=True,
 
     def add_output(self, name='output', multi_output=True, display_name=True,
                    color=None, locked=False, painter_func=None):
+        """
+        Warnings:
+            This function is called by :meth:`NodeGraphQt.SubGraph.expand_group_node`
+            and is not available for the ``PortInputNode`` class.
+        """
         if self._outputs:
             raise PortRegistrationError(
                 '"{}.add_output()" only ONE output is allowed for this node.'
@@ -98,6 +104,11 @@ def parent_port(self):
 
     def add_input(self, name='input', multi_input=False, display_name=True,
                   color=None, locked=False, painter_func=None):
+        """
+        Warnings:
+            This function is called by :meth:`NodeGraphQt.SubGraph.expand_group_node`
+            and is not available for the ``PortOutputNode`` class.
+        """
         if self._inputs:
             raise PortRegistrationError(
                 '"{}.add_input()" only ONE input is allowed for this node.'
@@ -115,7 +126,8 @@ def add_input(self, name='input', multi_input=False, display_name=True,
     def add_output(self, name='output', multi_output=True, display_name=True,
                    color=None, locked=False, painter_func=None):
         """
-        This is not available for the `PortOutputNode` class.
+        Warnings:
+            This is not available for the ``PortOutputNode`` class.
         """
         raise PortRegistrationError(
             '"{}.add_output()" is not available for {}.'

docs/graph.rst

@@ -11,6 +11,7 @@ NodeGraph
 .. autoclass:: NodeGraphQt.NodeGraph
     :members:
     :exclude-members: model, widget
+    :member-order: bysource
 
     .. autoattribute:: NodeGraphQt.NodeGraph.widget
     .. autoattribute:: NodeGraphQt.NodeGraph.model

docs/nodes/BackdropNode.rst

@@ -3,3 +3,4 @@ BackdropNode
 
 .. autoclass:: NodeGraphQt.BackdropNode
     :members:
+    :member-order: bysource

docs/nodes/BaseNode.rst

@@ -4,10 +4,12 @@ BaseNode
 .. autoclass:: NodeGraphQt.BaseNode
     :members:
     :exclude-members: update_model, set_layout_direction, set_property
+    :member-order: bysource
 
 BaseNode (Circle)
 #################
 
 .. autoclass:: NodeGraphQt.BaseNodeCircle
     :members:
-    :exclude-members: update_model, set_layout_direction
+    :exclude-members: update_model, set_layout_direction
+    :member-order: bysource

docs/nodes/GroupNode.rst

@@ -3,4 +3,5 @@ GroupNode
 
 .. autoclass:: NodeGraphQt.GroupNode
     :members:
-    :exclude-members: add_input, add_output, delete_input, delete_output
+    :exclude-members: add_input, add_output, delete_input, delete_output
+    :member-order: bysource

docs/nodes/NodeObject.rst

@@ -4,6 +4,7 @@ NodeObject
 .. autoclass:: NodeGraphQt.NodeObject
     :members:
     :exclude-members: NODE_NAME, graph, id, model, type_, view
+    :member-order: bysource
 
     .. autoattribute:: NODE_NAME
         :annotation:

docs/nodes/Port.rst

@@ -4,3 +4,4 @@ Port
 .. autoclass:: NodeGraphQt.Port
     :members:
     :exclude-members: model, view
+    :member-order: bysource

docs/nodes/PortNode.rst

@@ -4,17 +4,20 @@ PortNode
 Port node are the nodes in a expanded :class:`NodeGraphQt.SubGraph` that
 represent the ports from the parent :class:`NodeGraphQt.GroupNode` object.
 
+|
 
 PortInputNode
 =============
 
 .. autoclass:: NodeGraphQt.nodes.port_node.PortInputNode
     :members:
-    :exclude-members: add_input, add_output
+    :member-order: bysource
+
+|
 
 PortOutputNode
 ==============
 
 .. autoclass:: NodeGraphQt.nodes.port_node.PortOutputNode
     :members:
-    :exclude-members: add_input, add_output
+    :member-order: bysource

docs/nodes/_index_nodes.rst

@@ -1,7 +1,7 @@
 Nodes
 #####
 
-| Node object types from the NodeGraphQt module.
+| Node object types from the ``NodeGraphQt`` module.
 
 .. toctree::
     :caption: Node Classes