docs clean up

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -24,7 +24,12 @@
 
 class NodeGraph(QtCore.QObject):
     """
-    base node graph controller.
+    The ``NodeGraph`` class is the main controller for managing all nodes.
+
+    Inherited from: ``PySide2.QtCore.QObject``
+
+    .. image:: _images/graph.png
+        :width: 60%
     """
 
     #:QtCore.Signal: emits the node object when a node is created in the node graph.

NodeGraphQt/base/node.py

@@ -27,7 +27,10 @@ def __get__(self, instance, owner):
 
 class NodeObject(object):
     """
-    base class for all node objects.
+    The ``NodeGraphQt.NodeObject`` class is the main base class that all
+    nodes inherit from.
+
+    **Inherited by:** :class:`NodeGraphQt.BaseNode`, :class:`NodeGraphQt.BackdropNode`
 
     Args:
         qgraphics_item (AbstractNodeItem): graphic item used for drawing.
@@ -78,7 +81,7 @@ def id(self):
     @property
     def graph(self):
         """
-        The parent node graph controller.
+        The parent node graph.
 
         Returns:
             NodeGraphQt.NodeGraph: node graph.
@@ -366,7 +369,37 @@ def pos(self):
 
 class BaseNode(NodeObject):
     """
-    base class of a typical Node with input and output ports.
+    The ``NodeGraphQt.BaseNode`` class is the base class for nodes that allows
+    port connections from one node to another.
+
+    **Inherited from:** :class:`NodeGraphQt.NodeObject`
+
+    .. image:: ../_images/node.png
+        :width: 250px
+
+    example snippet:
+
+    .. code-block:: python
+        :linenos:
+
+        from NodeGraphQt import BaseNode
+
+        class FooNode(BaseNode):
+
+            # unique node identifier domain.
+            __identifier__ = 'com.chantasticvfx'
+
+            # initial default node name.
+            NODE_NAME = 'Foo Node'
+
+            def __init__(self):
+                super(FooNode, self).__init__()
+
+                # create an input port.
+                self.add_input('in')
+
+                # create an output port.
+                self.add_output('out')
     """
 
     NODE_NAME = 'Base Node'
@@ -664,7 +697,13 @@ def on_input_disconnected(self, in_port, out_port):
 
 class BackdropNode(NodeObject):
     """
-    base class of a Backdrop node.
+    The ``NodeGraphQt.BackdropNode`` class allows other node object to be
+    nested inside, it's mainly good for grouping nodes together.
+
+    **Inherited from:** :class:`NodeGraphQt.NodeObject`
+
+    .. image:: ../_images/backdrop.png
+        :width: 250px
     """
 
     NODE_NAME = 'Backdrop'

NodeGraphQt/base/port.py

@@ -10,7 +10,10 @@
 
 class Port(object):
     """
-    base class for a node port.
+    The ``Port`` class is used for connecting one node to another.
+
+    .. image:: ../_images/port.png
+        :width: 50%
 
     Args:
         node (NodeGraphQt.NodeObject): parent node.

docs/_static/ngqt.css

@@ -271,8 +271,8 @@ div.highlight{
 }
 
 div.note {
-    background-color: #544322;
-    border: 1px solid #bf9d3b;
+    background-color: #223854;
+    border: 1px solid #3b7cbf;
     border-radius: 4px;
 }
 
@@ -283,7 +283,9 @@ div.seealso {
 }
 
 div.topic {
-    background-color: #eee;
+    background-color: #232427;
+    border: 1px solid #2f3b4c;
+    border-radius: 4px;
 }
 
 div.warning {

docs/classes.rst

@@ -46,6 +46,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosectionlabel',
+    'sphinx.ext.autosummary',
     'sphinx.ext.coverage',
     'sphinx.ext.intersphinx',
     'sphinx.ext.napoleon',
@@ -56,6 +57,12 @@
     'PySide2': ('https://doc.qt.io/qtforpython/', None),
 }
 
+# autosummary generate stubs.
+autosummary_generate = True
+
+# autosummary overwrite generated stubs files.
+autosummary_generate_option = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/conf.py

@@ -1,5 +1,5 @@
 Constants
-*********
+#########
 
 .. automodule:: NodeGraphQt.constants
     :members:

docs/connections.rst

@@ -1,25 +1,11 @@
-Graph
-*****
-
-**Inherited from:** :class:`PySide2.QtCore.QObject`
-
-The ``NodeGraph`` class is the main controller for managing all nodes.
-
-.. image:: _images/graph.png
-    :width: 60%
-
 NodeGraph
-=========
-
-NodeGraph Attributes
---------------------
-
-.. autoattribute:: NodeGraphQt.NodeGraph.widget
-.. autoattribute:: NodeGraphQt.NodeGraph.model
-
-NodeGraph Class
----------------
+#########
 
 .. autoclass:: NodeGraphQt.NodeGraph
     :members:
     :exclude-members: model, widget
+
+----
+
+.. autoattribute:: NodeGraphQt.NodeGraph.widget
+.. autoattribute:: NodeGraphQt.NodeGraph.model

docs/constants.rst

@@ -1,21 +1,22 @@
 NodeGraphQt
-***********
+###########
 
 Welcome to the ``NodeGraphQt`` documentation.
 
-.. image:: _images/example_result.png
-    :width: 60%
+.. image:: _images/screenshot.png
+    :width: 95%
 
-Project: https://github.com/jchanvfx/NodeGraphQt
+Project Repo: https://github.com/jchanvfx/NodeGraphQt
 
-
-Contents
-========
+----
 
 .. toctree::
+    :name: mastertoc
     :maxdepth: 3
 
     overview
     constants
-    classes
+    graph
+    nodes
+    menu
     widgets