docs update clean up.

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -585,16 +585,17 @@ def set_grid_color(self, r, g, b):
 
     def set_grid_mode(self, mode=None):
         """
-        Set node graph grid mode.
+        Set node graph background grid mode.
 
-        Note:
-            By default grid mode is set to "VIEWER_GRID_LINES".
+        (default: :attr:`NodeGraphQt.constants.ViewerEnum.GRID_DISPLAY_LINES`).
+
+        See: :attr:`NodeGraphQt.constants.ViewerEnum`
 
-            Node graph background types:
+        .. code-block:: python
+            :linenos:
 
-            * :attr:`NodeGraphQt.constants.ViewerEnum.GRID_DISPLAY_NONE.value`
-            * :attr:`NodeGraphQt.constants.ViewerEnum.GRID_DISPLAY_DOTS.value`
-            * :attr:`NodeGraphQt.constants.ViewerEnum.GRID_DISPLAY_LINES.value`
+            graph = NodeGraph()
+            graph.set_grid_mode(ViewerEnum.CURVED.value)
 
         Args:
             mode (int): background style.
@@ -695,7 +696,8 @@ def get_context_menu(self, menu):
         """
         Returns the context menu specified by the name.
 
-        Menu Types:
+        menu types:
+
             - ``"graph"`` context menu from the node graph.
             - ``"nodes"`` context menu for the nodes.
 
@@ -840,7 +842,8 @@ def disable_context_menu(self, disabled=True, name='all'):
         """
         Disable/Enable context menus from the node graph.
 
-        Menu Types:
+        menu types:
+
             - ``"all"`` all context menus from the node graph.
             - ``"graph"`` context menu from the node graph.
             - ``"nodes"`` context menu for the nodes.
@@ -947,19 +950,19 @@ def set_pipe_slicing(self, mode=True):
 
     def set_pipe_style(self, style=PipeLayoutEnum.CURVED.value):
         """
-        Set node graph pipes to be drawn as straight, curved or angled.
+        Set node graph pipes to be drawn as curved `(default)`, straight or angled.
 
-        .. image:: _images/pipe_layout_types.gif
-            :width: 80%
+        .. code-block:: python
+            :linenos:
 
-        Note:
-            By default pipe layout is set to "PIPE_LAYOUT_CURVED".
+            graph = NodeGraph()
+            graph.set_pipe_style(PipeLayoutEnum.CURVED.value)
 
-            Pipe Layout Styles:
+        See: :attr:`NodeGraphQt.constants.PipeLayoutEnum`
+
+        .. image:: _images/pipe_layout_types.gif
+            :width: 80%
 
-            * :attr:`NodeGraphQt.constants.PipeLayoutEnum.CURVED.value`
-            * :attr:`NodeGraphQt.constants.PipeLayoutEnum.STRAIGHT.value`
-            * :attr:`NodeGraphQt.constants.PipeLayoutEnum.ANGLE.value`
 
         Args:
             style (int): pipe layout style.

NodeGraphQt/base/menu.py

@@ -12,6 +12,9 @@ class NodeGraphMenu(object):
     """
     The ``NodeGraphMenu`` is the main context menu triggered from the node graph.
 
+    .. inheritance-diagram:: NodeGraphQt.NodeGraphMenu
+        :parts: 1
+
     example for accessing the node graph context menu.
 
     .. code-block:: python
@@ -86,7 +89,7 @@ def get_command(self, name):
             name (str): name of the command.
 
         Returns:
-            NodeGraphQt.MenuCommand: context menu command.
+            NodeGraphQt.NodeGraphCommand: context menu command.
         """
         return self._commands.get(name)
 
@@ -159,7 +162,8 @@ class NodesMenu(NodeGraphMenu):
     """
     The ``NodesMenu`` is the context menu triggered from a node.
 
-    **Inherited from:** :class:`NodeGraphQt.NodeGraphMenu`
+    .. inheritance-diagram:: NodeGraphQt.NodesMenu
+        :parts: 1
 
     example for accessing the nodes context menu.
 
@@ -230,6 +234,10 @@ def add_command(self, name, func=None, node_type=None, node_class=None):
 class NodeGraphCommand(object):
     """
     Node graph menu command.
+
+    .. inheritance-diagram:: NodeGraphQt.NodeGraphCommand
+        :parts: 1
+
     """
 
     def __init__(self, graph, qaction, func=None):

docs/_images/pipe_layout_menu.png

@@ -1,7 +1,7 @@
 Built-in Widgets
 ################
 
-The ``NodeGraphQt`` framework comes included with a few custom widgets.
+| The ``NodeGraphQt`` framework comes included with a few custom widgets.
 
 
 Properties Bin

docs/custom_widgets.rst

@@ -8,7 +8,7 @@ Menu Overview
 Default Context Menu
 ********************
 
-The ``NodeGraphQt.NodeGraph`` has a context menu can be accessed with
+The :class:`NodeGraphQt.NodeGraph` has a context menu can be accessed with
 :meth:`NodeGraph.context_menu`.
 
 
@@ -19,7 +19,8 @@ It can also be populated it with a config file in ``JSON`` format by using
     :width: 300px
 
 | Here's a link to the example config file with a few essential menu commands.
-| https://github.com/jchanvfx/NodeGraphQt/blob/master/examples/hotkeys/hotkeys.json
+| `example JSON config file <https://github.com/jchanvfx/NodeGraphQt/blob/master/examples/hotkeys/hotkeys.json>`_
+
 
 Adding to the Graph Menu
 ************************

docs/examples/ex_menu.rst

@@ -39,6 +39,7 @@ Creating Nodes
 
         app.exec_()
 
+|
 
 Creating Node Widgets
 *********************
@@ -80,6 +81,8 @@ To you update the widget you can call the
 
 See: :ref:`Node Widgets` for more node widget types.
 
+|
+
 Embedding Custom Widgets
 ************************
 
@@ -230,6 +233,7 @@ connecting nodes with the port objects:
         - :func:`NodeGraphQt.Port.connect_to`
         - :func:`NodeGraphQt.Port.disconnect_from`
 
+|
 
 Connecting a PropertiesBin
 **************************

docs/examples/ex_node.rst

@@ -9,13 +9,13 @@ User interface overview for the node graph.
 Navigation
 **********
 
-+---------------+----------------------------------------------+
-| action        | controls                                     |
-+===============+==============================================+
-| Zoom in/out   | *Alt + MMB + Drag* or *Mouse Scroll Up/Down* |
-+---------------+----------------------------------------------+
-| Pan           | *Alt + LMB + Drag* or *MMB + Drag*           |
-+---------------+----------------------------------------------+
++---------------+----------------------------------------------------+
+| action        | controls                                           |
++===============+====================================================+
+| Zoom In/Out   | ``Alt + MMB + Drag`` or ``Mouse Scroll Up/Down``   |
++---------------+----------------------------------------------------+
+| Pan           | ``Alt + LMB + Drag`` or ``MMB + Drag``             |
++---------------+----------------------------------------------------+
 
 Node Selection
 **************
@@ -33,11 +33,11 @@ Tab Search
 
 Nodes registered in the node graph can be created with the tab search widget.
 
-+-------------------+--------+
-| action            | hotkey |
-+===================+========+
-| Toggle Visibility | *Tab*  |
-+-------------------+--------+
++-------------------+----------+
+| action            | hotkey   |
++===================+==========+
+| Toggle Visibility | ``Tab``  |
++-------------------+----------+
 
 Pipe Slicing
 ************
@@ -47,11 +47,11 @@ Pipe Slicing
 
 Connection pipes can be disconnected easily with the built in slice tool.
 
-+---------------------+----------------------------+
-| action              | controls                   |
-+=====================+============================+
-| Slice connections   | *Alt + Shift + LMB + Drag* |
-+---------------------+----------------------------+
++---------------------+------------------------------+
+| action              | controls                     |
++=====================+==============================+
+| Slice Connections   | ``Alt + Shift + LMB + Drag`` |
++---------------------+------------------------------+
 
 Additional Info:
     To disable or enable the pipe slicer see

docs/examples/ex_overview.rst

@@ -11,25 +11,26 @@ The :class:`NodeGraphQt.NodeGraph` class has 3 different pipe layout styles as
 shown above this can be set easily with the :meth:`NodeGraphQt.NodeGraph.set_pipe_style`
 function.
 
-Here's a super simple example snippet for setting the pipe layout style to be angled.
+|
+| Here's a example snippet for setting the pipe layout style to be "angled".
 
 .. code-block:: python
     :linenos:
 
     from NodeGraphQt import NodeGraph
-    from NodeGraphQt.constants import PIPE_LAYOUT_ANGLE
+    from NodeGraphQt.constants import PipeLayoutEnum
 
     graph = NodeGraph()
-    graph.set_pipe_style(PIPE_LAYOUT_ANGLE)
+    graph.set_pipe_style(PipeLayoutEnum.ANGLE.value)
 
-Constants variables for the 3 different pipe layout styles:
+| There are 3 different pipe layout styles see: :attr:`NodeGraphQt.constants.PipeLayoutEnum`
 
- - ``Curved``: :attr:`NodeGraphQt.constants.PIPE_LAYOUT_CURVED`
- - ``Straight``: :attr:`NodeGraphQt.constants.PIPE_LAYOUT_STRAIGHT`
- - ``Angle``: :attr:`NodeGraphQt.constants.PIPE_LAYOUT_ANGLE`
+.. note::
 
-Note: if you've set up your node graph with the ``NodeGraphQt.setup_context_menu``
-is a convenience function then you'll already have the actions to set the pipe
-layout under "Edit>Pipe".
+    If you've set up your node graph with the :meth:`NodeGraph.set_context_menu_from_file`
+    function and the example
+    `example JSON <https://github.com/jchanvfx/NodeGraphQt/blob/master/examples/hotkeys/hotkeys.json>`_
+    then you'll already have the actions to set the pipe layout under the
+    "Pipes" menu.
 
-.. image:: ../_images/pipe_layout_menu.png
+    .. image:: ../_images/pipe_layout_menu.png

docs/examples/ex_pipe.rst

@@ -4,7 +4,7 @@ Port Overview
 Creating Custom Shapes
 **********************
 
-(*Implemented on* ``v0.1.1``)
+| (*Implemented on* ``v0.1.1``)
 
 To have custom port shapes the :meth:`NodeGraphQt.BaseNode.add_input` and
 :meth:`NodeGraphQt.BaseNode.add_output` functions now have a ``painter_func``
@@ -13,6 +13,8 @@ argument where you specify you custom port painter function.
 .. image:: ../_images/custom_ports.png
         :width: 178px
 
+|
+
 Example Triangle Port
 *********************
 
@@ -89,6 +91,8 @@ The ``draw_triangle_port`` painter function can then be passed to the ``painter_
             # create a input port with custom painter function.
             self.add_input('triangle', painter_func=draw_triangle_port)
 
+|
+
 Example Square Port
 *******************
 

docs/examples/ex_port.rst

@@ -8,29 +8,35 @@ Menus
     Context menus can also be set from a config file or a dictionary with:
     :meth:`NodeGraph.set_context_menu_from_file`, :meth:`NodeGraph.set_context_menu`
 
+|
 
-Graph Menu
-**********
+GraphMenu
+*********
 
 | The context menu triggered from the node graph.
 
 .. autoclass:: NodeGraphMenu
     :members:
     :exclude-members: qmenu
+    :member-order: bysource
 
+|
 
-Nodes Menu
-**********
+NodesMenu
+*********
 
 | The context menu triggered from a node.
 
 .. autoclass:: NodesMenu
     :members:
+    :member-order: bysource
 
+|
 
-Command
-*******
+NodeGraphCommand
+****************
 
 .. autoclass:: NodeGraphCommand
     :members:
     :exclude-members: qaction
+    :member-order: bysource