Merge pull request #323 from jchanvfx/docs_clean_up

jchanvfx · web-flow · commit ef82ada5890a · 2023-04-18T12:26:19.000+12:00
docs clean up &amp; updates.
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,7 @@ venv/*
 
 # sphinx documentation
 docs/_build/
-api/doctrees
+api/*
 
 # python stuff
 *.pyc
diff --git a/NodeGraphQt/base/graph.py b/NodeGraphQt/base/graph.py
@@ -995,22 +995,21 @@ def set_layout_direction(self, direction):
 
         `Implemented in` ``v0.3.0``
 
-        See Also:
-            :meth:`NodeGraph.layout_direction`,
-            :meth:`NodeObject.set_layout_direction`
-
-        Note:
-            Node Graph Layout Types:
+        **Layout Types:**
 
-            * :attr:`NodeGraphQt.constants.LayoutDirectionEnum.HORIZONTAL`
-            * :attr:`NodeGraphQt.constants.LayoutDirectionEnum.VERTICAL`
+        - :attr:`NodeGraphQt.constants.LayoutDirectionEnum.HORIZONTAL`
+        - :attr:`NodeGraphQt.constants.LayoutDirectionEnum.VERTICAL`
 
-            .. image:: _images/layout_direction_switch.gif
-                :width: 300px
+        .. image:: _images/layout_direction_switch.gif
+            :width: 300px
 
         Warnings:
             This function does not register to the undo stack.
 
+        See Also:
+            :meth:`NodeGraph.layout_direction`,
+            :meth:`NodeObject.set_layout_direction`
+
         Args:
             direction (int): layout direction.
         """
diff --git a/NodeGraphQt/base/node.py b/NodeGraphQt/base/node.py
@@ -38,7 +38,7 @@ class NodeObject(object):
             class ExampleNode(NodeObject):
     
                 # unique node identifier domain.
-                __identifier__ = 'io.jchanvfx.github'
+                __identifier__ = 'io.github.jchanvfx'
     
                 def __init__(self):
                     ...
diff --git a/NodeGraphQt/base/port.py b/NodeGraphQt/base/port.py
@@ -19,7 +19,7 @@ class Port(object):
 
     .. inheritance-diagram:: NodeGraphQt.Port
 
-    .. image:: ../_images/port.png
+    .. image:: _images/port.png
         :width: 50%
 
     See Also:
diff --git a/NodeGraphQt/nodes/group_node.py b/NodeGraphQt/nodes/group_node.py
@@ -8,7 +8,7 @@ class GroupNode(BaseNode):
     """
     `Implemented in` ``v0.2.0``
 
-    The ``NodeGraphQt.GroupNode`` class extends from the :class:``NodeGraphQt.BaseNode``
+    The ``NodeGraphQt.GroupNode`` class extends from the :class:`NodeGraphQt.BaseNode`
     class with the ability to nest other nodes inside of it.
 
     .. inheritance-diagram:: NodeGraphQt.GroupNode
diff --git a/NodeGraphQt/nodes/port_node.py b/NodeGraphQt/nodes/port_node.py
@@ -7,7 +7,7 @@
 
 class PortInputNode(BaseNode):
     """
-    The ``PortInputNode`` class is the node object that represents a port from a
+    The ``PortInputNode`` is the node that represents a input port from a
     :class:`NodeGraphQt.GroupNode` when expanded in a
     :class:`NodeGraphQt.SubGraph`.
 
@@ -71,8 +71,8 @@ def add_output(self, name='output', multi_output=True, display_name=True,
 
 class PortOutputNode(BaseNode):
     """
-    The ``PortOutputNode`` class is the node object that represents a port
-    from a :class:`NodeGraphQt.GroupNode` when expanded in a
+    The ``PortOutputNode`` is the node that represents a output port from a
+    :class:`NodeGraphQt.GroupNode` when expanded in a
     :class:`NodeGraphQt.SubGraph`.
 
     .. inheritance-diagram:: NodeGraphQt.nodes.port_node.PortOutputNode
diff --git a/README.md b/README.md
@@ -25,12 +25,8 @@ https://jchanvfx.github.io/NodeGraphQt/api/html/examples/ex_overview.html#simple
 
 <img src="/docs/_images/pipe_layout_types.gif" width="600" title="Pipe Layout">
 
-#### Slice Connections
-
-<img src="/docs/_images/slicer.png" width="500" title="Pipe Slicer">
-
 #### Custom Widgets
-<img src="/docs/_images/prop_bin.png" width="600" title="Properties Bin">
-<img src="/docs/_images/nodes_palette.png" width="350" title="Nodes Paletten">
 
+https://jchanvfx.github.io/NodeGraphQt/api/html/custom_widgets.html
 
+<img src="/docs/_images/prop_bin.png" width="600" title="Properties Bin">
diff --git a/docs/custom_widgets.rst b/docs/custom_widgets.rst
@@ -3,24 +3,30 @@ Built-in Widgets
 
 | The ``NodeGraphQt`` framework comes included with a few custom widgets.
 
+**Classes:**
+
+.. autosummary::
+    NodeGraphQt.PropertiesBinWidget
+    NodeGraphQt.NodesPaletteWidget
+    NodeGraphQt.NodesTreeWidget
 
 Properties Bin
 **************
 
 .. autoclass:: NodeGraphQt.PropertiesBinWidget
     :members:
-    :exclude-members: property_changed
+    :exclude-members: staticMetaObject
 
 Nodes Palette
 *************
 
 .. autoclass:: NodeGraphQt.NodesPaletteWidget
     :members:
-    :exclude-members: mimeData,
+    :exclude-members: mimeData, staticMetaObject
 
 Nodes Tree
 **********
 
 .. autoclass:: NodeGraphQt.NodesTreeWidget
     :members:
-    :exclude-members: mimeData
+    :exclude-members: mimeData, staticMetaObject
diff --git a/docs/examples/ex_menu.rst b/docs/examples/ex_menu.rst
@@ -3,7 +3,7 @@ Menu Overview
 
 .. currentmodule:: NodeGraphQt
 
-| Examples for customizing context menus in NodeGraphQt.
+| Examples for customizing context menus in ``NodeGraphQt``.
 
 Default Context Menu
 ********************
diff --git a/docs/examples/ex_overview.rst b/docs/examples/ex_overview.rst
@@ -66,8 +66,6 @@ Here's a basic example snippet for creating two nodes and connecting them togeth
 .. code-block:: python
     :linenos:
 
-    import sys
-
     from Qt import QtWidgets
     from NodeGraphQt import NodeGraph, BaseNode
 
@@ -92,7 +90,7 @@ Here's a basic example snippet for creating two nodes and connecting them togeth
 
 
     if __name__ == '__main__':
-        app = QtWidgets.QApplication(sys.argv)
+        app = QtWidgets.QApplication([])
 
         # create node graph controller.
         graph = NodeGraph()
diff --git a/docs/examples/ex_pipe.rst b/docs/examples/ex_pipe.rst
@@ -1,8 +1,8 @@
 Pipe Overview
 #############
 
-Pipe Layouts
-************
+Layout Styles
+*************
 
 .. image:: ../_images/pipe_layout_types.gif
         :width: 650px
@@ -33,4 +33,14 @@ function.
     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
+
+
+Layout Direction
+****************
+
+The :class:`NodeGraphQt.NodeGraph` pipes can also be set with a vertical layout
+direction with the  :meth:`NodeGraphQt.NodeGraph.set_layout_direction` function.
+
+.. image:: ../_images/vertical_layout.png
+    :width: 450px
diff --git a/docs/graph.rst b/docs/graph.rst
@@ -3,6 +3,8 @@ Graphs
 
 | `See` :ref:`Getting Started` `from the overview section.`
 
+**Classes:**
+
 .. autosummary::
     NodeGraphQt.NodeGraph
     NodeGraphQt.SubGraph
@@ -13,6 +15,7 @@ NodeGraph
 .. autoclass:: NodeGraphQt.NodeGraph
     :members:
     :member-order: bysource
+    :exclude-members: staticMetaObject
 
 |
 
@@ -21,4 +24,4 @@ SubGraph
 
 .. autoclass:: NodeGraphQt.SubGraph
     :members:
-    :exclude-members: delete_node, delete_nodes, is_root, sub_graphs, widget
+    :exclude-members: staticMetaObject, delete_node, delete_nodes, is_root, sub_graphs, widget
diff --git a/docs/index.rst b/docs/index.rst
@@ -20,6 +20,7 @@ and re-purposed into applications supporting PySide2.
     constants
     graph
     nodes/_index_nodes
+    port
     menu
 
 .. toctree::
@@ -31,7 +32,7 @@ and re-purposed into applications supporting PySide2.
     node_widgets
 
 .. toctree::
-    :caption: Usage
+    :caption: Examples
     :name: exmplstoc
     :maxdepth: 1
 
diff --git a/docs/menu.rst b/docs/menu.rst
@@ -1,12 +1,11 @@
 Menus
 #####
 
-.. currentmodule:: NodeGraphQt
+| `See` :ref:`Menu Overview` `from the overview section.`
 
-.. seealso::
+.. currentmodule:: NodeGraphQt
 
-    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`
+**Classes:**
 
 .. autosummary::
     NodeGraphMenu
diff --git a/docs/node_widgets.rst b/docs/node_widgets.rst
@@ -2,48 +2,43 @@ Node Widgets
 ############
 
 | Node widgets are the widgets that can be embedded into a
- :class:`NodeGraphQt.BaseNode` and displayed in the node graph.
+  :class:`NodeGraphQt.BaseNode` and displayed in the node graph.
 
-.. seealso::
+| To create your own widget embedded in a node see the
+  :ref:`Embedding Custom Widgets` example page.
 
-    To create your own widget embedded in a node see the
-    :ref:`Embedding Custom Widgets` example page.
+**Classes:**
+
+.. autosummary::
+    NodeGraphQt.NodeBaseWidget
+    NodeGraphQt.widgets.node_widgets.NodeCheckBox
+    NodeGraphQt.widgets.node_widgets.NodeComboBox
+    NodeGraphQt.widgets.node_widgets.NodeLineEdit
 
 NodeBaseWidget
 **************
 
 .. autoclass:: NodeGraphQt.NodeBaseWidget
     :members:
-    :exclude-members: node, setToolTip, type_, value, widget
-
------
-
-.. note::
-    Below are the classes for the :class:`NodeGraphQt.BaseNode` builtin
-    functions:
-
-     - ``QCheckBox``: :meth:`NodeGraphQt.BaseNode.add_checkbox`
-     - ``QComboBox``: :meth:`NodeGraphQt.BaseNode.add_combo_menu`
-     - ``QLineEdit``: :meth:`NodeGraphQt.BaseNode.add_text_input`
-
+    :exclude-members: staticMetaObject, node, setToolTip, type_, value, widget
 
 NodeCheckBox
 ************
 
 .. autoclass:: NodeGraphQt.widgets.node_widgets.NodeCheckBox
     :members:
-    :exclude-members: widget, type_
+    :exclude-members: staticMetaObject, widget, type_
 
 NodeComboBox
 ************
 
 .. autoclass:: NodeGraphQt.widgets.node_widgets.NodeComboBox
     :members:
-    :exclude-members: widget, type_
+    :exclude-members: staticMetaObject, widget, type_
 
 NodeLineEdit
 ************
 
 .. autoclass:: NodeGraphQt.widgets.node_widgets.NodeLineEdit
     :members:
-    :exclude-members: widget, type_
+    :exclude-members: staticMetaObject, widget, type_
diff --git a/docs/nodes/PortNode.rst b/docs/nodes/PortNode.rst
@@ -1,9 +1,11 @@
-PortNodes
-#########
+Port Nodes
+##########
 
 | Port nodes are the nodes in a expanded :class:`NodeGraphQt.SubGraph` that
   represent the ports from the parent :class:`NodeGraphQt.GroupNode` object.
 
+**Classes:**
+
 .. autosummary::
     NodeGraphQt.nodes.port_node.PortInputNode
     NodeGraphQt.nodes.port_node.PortOutputNode
@@ -12,19 +14,12 @@ PortNodes
 
 .. hint::
 
-    To access a port node a :class:`NodeGraphQt.GroupNode` need to be expanded
-    which can be done with one of the follow functions:
-
-    :meth:`NodeGraphQt.NodeGraph.GroupNode.expand`,
-    :meth:`NodeGraphQt.NodeGraph.expand_group_node`,
-    :meth:`NodeGraphQt.SubGraph.expand_group_node`
-
-
-    Port nodes object can accessed with:
+    Port node objects can be accessed in a expanded
+    :class:`NodeGraphQt.GroupNode` with:
 
-    :meth:`NodeGraphQt.SubGraph.get_node_by_port`,
-    :meth:`NodeGraphQt.SubGraph.get_input_port_nodes`,
-    :meth:`NodeGraphQt.SubGraph.get_output_port_nodes`
+    - :meth:`NodeGraphQt.SubGraph.get_node_by_port`,
+    - :meth:`NodeGraphQt.SubGraph.get_input_port_nodes`,
+    - :meth:`NodeGraphQt.SubGraph.get_output_port_nodes`
 
 |
 
diff --git a/docs/nodes/_index_nodes.rst b/docs/nodes/_index_nodes.rst
@@ -8,7 +8,6 @@ Nodes
     :name: nodestoc
     :maxdepth: 2
 
-    Port
     NodeObject
     BackdropNode
     BaseNode
diff --git a/docs/port.rst b/docs/port.rst
