doc formatting tweaks.

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -26,7 +26,7 @@ class NodeGraph(QtCore.QObject):
     """
     The ``NodeGraph`` class is the main controller for managing all nodes.
 
-    Inherited from: ``PySide2.QtCore.QObject``
+    Inherited from: :class:`PySide2.QtCore.QObject`
 
     .. image:: _images/graph.png
         :width: 60%
@@ -86,6 +86,7 @@ class NodeGraph(QtCore.QObject):
     Signal is triggered when data has been dropped to the graph.
     
     :parameters: :class:`PySide2.QtCore.QMimeData`, :class:`PySide2.QtCore.QPoint`
+    :emits: mime data, node graph position
     """
 
     def __init__(self, parent=None):
@@ -309,7 +310,7 @@ def viewer(self):
 
         See Also:
             :attr:`NodeGraph.widget` for adding the node graph into a 
-            QtWidgets.QLayout.
+            :class:`PySide2.QtWidgets.QLayout`.
 
         Returns:
             NodeGraphQt.widgets.viewer.NodeViewer: viewer interface.
@@ -468,7 +469,7 @@ def get_context_menu(self, menu):
             menu (str): menu name.
 
         Returns:
-            NodeGraphMenu or NodesMenu: context menu object.
+            NodeGraphQt.NodeGraphMenu or NodeGraphQt.NodesMenu: context menu object.
         """
         menus = self._viewer.context_menus()
         if menus.get(menu):

docs/examples/ex_index.rst

@@ -5,7 +5,7 @@ Creating Nodes
 **************
 
 | Creating is done simply by calling the :func:`NodeGraphQt.NodeGraph.create_node` function.
-| (`see example below` ``line22``)
+| (`see example below` ``line: 22``)
 
 .. code-block:: python
     :linenos:
@@ -66,16 +66,16 @@ connecting nodes with the port objects:
     # make the connection.
     port_a.connect_to(port_b)
 
+`more on ports and connections.`
 
-more on ports and connections:
-    - :func:`NodeGraphQt.BaseNode.input`,
-    - :func:`NodeGraphQt.BaseNode.output`
-    - :func:`NodeGraphQt.BaseNode.set_input`,
-    - :func:`NodeGraphQt.BaseNode.set_output`,
-    - :func:`NodeGraphQt.BaseNode.inputs`,
-    - :func:`NodeGraphQt.BaseNode.outputs`
-    - :func:`NodeGraphQt.Port.connect_to`,
-    - :func:`NodeGraphQt.Port.disconnect_from`
+        - :func:`NodeGraphQt.BaseNode.input`
+        - :func:`NodeGraphQt.BaseNode.output`
+        - :func:`NodeGraphQt.BaseNode.set_input`
+        - :func:`NodeGraphQt.BaseNode.set_output`
+        - :func:`NodeGraphQt.BaseNode.inputs`
+        - :func:`NodeGraphQt.BaseNode.outputs`
+        - :func:`NodeGraphQt.Port.connect_to`
+        - :func:`NodeGraphQt.Port.disconnect_from`
 
 
 Widget Example
@@ -133,6 +133,7 @@ Here's an example where we subclass the ``NodeGraph`` and connect it up to a
 
         app.exec_()
 
-more on the properties bin and node_double_clicked signal:
+`more on the properties bin and node_double_clicked signal`
+
     - :class:`NodeGraphQt.PropertiesBinWidget`
     - :attr:`NodeGraphQt.NodeGraph.node_double_clicked`

docs/examples/ex_node.rst

@@ -1,5 +1,5 @@
-Graph Overview
-##############
+NodeGraph Overview
+##################
 
 User interface overview for the node graph.
 
@@ -68,6 +68,7 @@ Here's a basic example snippet for creating two nodes and connecting them togeth
     from NodeGraphQt import NodeGraph, BaseNode, setup_context_menu
 
 
+    # create a node class object inherited from BaseNode.
     class FooNode(BaseNode):
 
         # unique node identifier domain.

docs/examples/ex_overview.rst

@@ -1,6 +1,10 @@
 NodeGraph
 #########
 
+`See` :ref:`Basic Example` `from the NodeGraph overview.`
+
+----
+
 .. autoclass:: NodeGraphQt.NodeGraph
     :members:
     :exclude-members: model, widget

docs/examples/ex_toc.rst

@@ -26,4 +26,6 @@ GitHub Project: https://github.com/jchanvfx/NodeGraphQt
     :name: examplestoc
     :maxdepth: 3
 
-    examples/ex_toc
+    examples/ex_overview
+    examples/ex_node
+    examples/ex_menu