Skip to content

Commit 347ed13

Browse files
committed
docs clean up
1 parent 1a9e8d0 commit 347ed13

File tree

4 files changed

+27
-15
lines changed

4 files changed

+27
-15
lines changed

docs/custom_widgets.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Custom Widgets
2-
##############
1+
Built-in Widgets
2+
################
33

4-
Here's a few custom widgets that included with the ``NodeGraphQt`` framework.
4+
The ``NodeGraphQt`` framework comes included with a few custom widgets.
55

66

77
Properties Bin

docs/examples/ex_node.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Creating Nodes
4040
app.exec_()
4141
4242
43-
Embedding Widgets
44-
*****************
43+
Creating Node Widgets
44+
*********************
4545

4646
The :class:`NodeGraphQt.BaseNode` class allows you to embed some basic widgets inside a node here's a
4747
example to simply embed a ``QComboBox`` widget when reimplementing the ``BaseNode``.
@@ -62,7 +62,8 @@ example to simply embed a ``QComboBox`` widget when reimplementing the ``BaseNod
6262
items = ['apples', 'bananas', 'pears', 'mangos', 'oranges']
6363
self.add_combo_menu('my_list', 'My List', items)
6464
65-
To you update the widget you can call the :meth:`NodeGraphQt.NodeObject.set_property` function.
65+
To you update the widget you can call the
66+
:meth:`NodeGraphQt.NodeObject.set_property` function.
6667

6768
.. code-block:: python
6869
:linenos:
@@ -77,7 +78,7 @@ To you update the widget you can call the :meth:`NodeGraphQt.NodeObject.set_prop
7778
- ``QCheckBox``: :meth:`NodeGraphQt.BaseNode.add_checkbox`
7879
- ``QLineEdit``: :meth:`NodeGraphQt.BaseNode.add_text_input`
7980

80-
See: :ref:`Embedded Node Widgets` for more node widget types.
81+
See: :ref:`Node Widgets` for more node widget types.
8182

8283
Embedding Custom Widgets
8384
************************

docs/index.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
NodeGraphQt |version_str|
22
#########################
33

4-
https://github.com/jchanvfx/NodeGraphQt
4+
NodeGraphQt a node graph UI framework written in python that can be implemented
5+
and re-purposed into applications supporting PySide2.
56

67
.. image:: _images/screenshot.png
78
:width: 95%
89

10+
| Source: https://github.com/jchanvfx/NodeGraphQt
11+
| Issue Tracker: https://github.com/jchanvfx/NodeGraphQt/issues
12+
913
----
1014

1115
.. toctree::
@@ -27,7 +31,7 @@ https://github.com/jchanvfx/NodeGraphQt
2731
node_widgets
2832

2933
.. toctree::
30-
:caption: Examples
34+
:caption: Usage
3135
:name: exmplstoc
3236
:maxdepth: 1
3337

docs/node_widgets.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Embedded Node Widgets
2-
#####################
1+
Node Widgets
2+
############
33

4-
| Node embedded widgets are the widgets that can be embedded into a
4+
| Node widgets are the widgets that can be embedded into a
55
:class:`NodeGraphQt.BaseNode` and displayed in the node graph.
66
7-
| To add you own widget in a node see the
8-
:ref:`Embedding Custom Widgets` example.
7+
| To create your own widget embedded in a node see the
8+
:ref:`Embedding Custom Widgets` example page.
99
1010
NodeBaseWidget
1111
**************
@@ -16,7 +16,14 @@ NodeBaseWidget
1616

1717
-----
1818

19-
Below are builtin node widgets inherited from :class:`NodeGraphQt.NodeBaseWidget`
19+
.. note::
20+
Below are the classes for the :class:`NodeGraphQt.BaseNode` builtin
21+
functions:
22+
23+
- ``QCheckBox``: :meth:`NodeGraphQt.BaseNode.add_checkbox`
24+
- ``QComboBox``: :meth:`NodeGraphQt.BaseNode.add_combo_menu`
25+
- ``QLineEdit``: :meth:`NodeGraphQt.BaseNode.add_text_input`
26+
2027

2128
NodeCheckBox
2229
************

0 commit comments

Comments
 (0)