doc string cleanup

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -829,7 +829,7 @@ def registered_nodes(self):
 
     def register_node(self, node, alias=None):
         """
-        Register the node to the :meth:`NodeGraph.node_factory
+        Register the node to the :meth:`NodeGraph.node_factory`
 
         Args:
             node (NodeGraphQt.NodeObject): node.
@@ -840,7 +840,7 @@ def register_node(self, node, alias=None):
 
     def register_nodes(self, nodes):
         """
-        Register the nodes to the :meth:`NodeGraph.node_factory
+        Register the nodes to the :meth:`NodeGraph.node_factory`
 
         Args:
             nodes (list[NodeGraphQt.NodeObject]): list of nodes.

NodeGraphQt/base/node.py

@@ -976,27 +976,32 @@ def delete_output(self, port):
 
     def set_ports(self, port_data):
         """
-        Set node input and output ports from specified port data.
-
-        example port data:
-            {
-                'input_ports':
-                    [{
-                        'name': 'input',
-                        'multi_connection': True,
-                        'display_name': 'Input',
-                        'data_type': 'NoneType',
-                        'locked': False
-                    }],
-                'output_ports':
-                    [{
-                        'name': 'output',
-                        'multi_connection': True,
-                        'display_name': 'Output',
-                        'data_type': 'NoneType',
-                        'locked': False
-                    }]
-            }
+        Create node input and output ports from specified port data.
+
+        Hint:
+            example snippet of port data.
+
+            .. highlight:: python
+            .. code-block:: python
+
+                {
+                    'input_ports':
+                        [{
+                            'name': 'input',
+                            'multi_connection': True,
+                            'display_name': 'Input',
+                            'data_type': 'NoneType',
+                            'locked': False
+                        }],
+                    'output_ports':
+                        [{
+                            'name': 'output',
+                            'multi_connection': True,
+                            'display_name': 'Output',
+                            'data_type': 'NoneType',
+                            'locked': False
+                        }]
+                }
 
         Args:
             port_data(dict): port data.

NodeGraphQt/constants.py

@@ -1,8 +1,14 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 import os
+
+from Qt import QtWidgets
+
 from .pkg_info import __version__
-from . import QtWidgets
+
+__doc__ = """
+The module contains variables used throughout the whole ``NodeGraphQt`` library.
+"""
 
 #: Current version of the NodeGraphQt framework.
 VERSION = __version__

docs/_themes/sphinx_rtd_theme/static/css/theme.css

@@ -3378,7 +3378,8 @@ input[type=checkbox][disabled],input[type=radio][disabled]{
     margin-bottom:0!important
 }
 .wy-table-responsive table td,.wy-table-responsive table th{
-    white-space:nowrap
+    /*white-space:nowrap;*/
+    white-space:break-word;
 }
 a{
     color: #20fde8;
@@ -4749,4 +4750,4 @@ h2 {
 /* func tweaks */
 html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname {
     margin-right: 2px;
-}
+}