Skip to content

Commit b0c7be7

Browse files
committed
updated docs
1 parent b45d6fc commit b0c7be7

File tree

6 files changed

+35
-18
lines changed

6 files changed

+35
-18
lines changed

docs/_images/backdrop.png

8.98 KB
Loading

docs/graph.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Graph
2-
#####
1+
Graphs
2+
######
33

44
NodeGraph
55
*********
@@ -14,3 +14,10 @@ NodeGraph
1414

1515
.. autoattribute:: NodeGraphQt.NodeGraph.widget
1616
.. autoattribute:: NodeGraphQt.NodeGraph.model
17+
18+
SubGraph
19+
********
20+
21+
.. autoclass:: NodeGraphQt.SubGraph
22+
:members:
23+
:exclude-members: delete_node, is_root, sub_graphs, widget

docs/menu.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,6 @@ Menus
33

44
.. currentmodule:: NodeGraphQt
55

6-
Setup Context Menu
7-
******************
8-
9-
The ``setup_context_menu`` is a convenience function that'll populate the main
10-
context menu on node graph.
11-
12-
.. autofunction:: setup_context_menu
13-
146
Graph Menu
157
**********
168

docs/nodes.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
Nodes
22
#####
33

4+
Node object types from the NodeGraphQt module.
5+
46
.. toctree::
57
:caption: Node Classes
68
:name: nodestoc
79
:maxdepth: 2
810

11+
nodes/Port
912
nodes/NodeObject
1013
nodes/BaseNode
11-
nodes/Port
14+
nodes/GroupNode
15+
nodes/PortNode
1216
nodes/BackdropNode

docs/nodes/GroupNode.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
BackdropNode
2-
############
1+
GroupNode
2+
#########
33

4-
.. autoclass:: NodeGraphQt.BackdropNode
4+
.. autoclass:: NodeGraphQt.GroupNode
55
:members:
6+
:exclude-members: add_input, add_output, delete_input, delete_output

docs/nodes/PortNode.rst

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
1-
GroupNode
2-
#########
1+
PortNode
2+
########
33

4-
.. autoclass:: NodeGraphQt.GroupNode
4+
Port node are the nodes in a expanded :class:`NodeGraphQt.SubGraph` that
5+
represent the ports from the parent :class:`NodeGraphQt.GroupNode` object.
6+
7+
PortInputNode
8+
=============
9+
10+
.. autoclass:: NodeGraphQt.nodes.port_node.PortInputNode
11+
:members:
12+
:exclude-members: add_input, add_output
13+
14+
PortOutputNode
15+
==============
16+
17+
.. autoclass:: NodeGraphQt.nodes.port_node.PortOutputNode
518
:members:
6-
:exclude-members: add_input, add_output, delete_input, delete_output
19+
:exclude-members: add_input, add_output

0 commit comments

Comments
 (0)