Skip to content

Commit 4f797c1

Browse files
committed
docs clean up
1 parent aae1653 commit 4f797c1

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

NodeGraphQt/constants.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@
106106
VIEWER_GRID_COLOR = (45, 45, 45)
107107
VIEWER_GRID_SIZE = 50
108108

109-
URI_SCHEME = 'NodeGraphQt://'
110-
URN_SCHEME = 'NodeGraphQt::'
109+
URI_SCHEME = 'nodegraphqt://'
110+
URN_SCHEME = 'nodegraphqt::'
111111

112112
# === PATHS ===
113113

docs/custom_widgets.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Builtin Widgets
2-
###############
1+
Custom Widgets
2+
##############
33

44
Here's a few custom widgets that included with the ``NodeGraphQt`` framework.
55

docs/examples/ex_node.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Creating Nodes
55
**************
66

77
| Creating a node is done by calling the :func:`NodeGraph.create_node` function.
8-
| (`see example below` ``line: 23``)
8+
| (`see example below from line` ``line: 23``)
99
1010
.. code-block:: python
1111
:linenos:
@@ -80,7 +80,7 @@ To you update the widget you can call the :meth:`NodeGraphQt.NodeObject.set_prop
8080
- ``QCheckBox``: :meth:`NodeGraphQt.BaseNode.add_checkbox`
8181
- ``QLineEdit``: :meth:`NodeGraphQt.BaseNode.add_text_input`
8282

83-
See: :ref:`Node Widgets` for more node widget types.
83+
See: :ref:`Node Embedded Widgets` for more node widget types.
8484

8585
Embedding Custom Widgets
8686
************************

docs/examples/ex_overview.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
NodeGraph Overview
2-
##################
1+
Basic Overview
2+
##############
33

44
User interface overview for the node graph.
55

@@ -54,8 +54,8 @@ Connection pipes can be disconnected easily with the built in slice tool.
5454
+---------------------+----------------------------+
5555

5656

57-
Basic Example
58-
*************
57+
Simple Example
58+
**************
5959

6060
Here's a basic example snippet for creating two nodes and connecting them together.
6161

docs/graph.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Graphs
44
NodeGraph
55
*********
66

7-
`See` :ref:`Basic Example` `from the NodeGraph overview.`
7+
`See` :ref:`Simple Example` `from the NodeGraph overview.`
88

99
----
1010

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ NodeGraphQt documentation.
1111
----
1212

1313
.. toctree::
14-
:caption: API
14+
:caption: API Reference
1515
:name: apitoc
1616
:maxdepth: 2
1717

@@ -21,7 +21,7 @@ NodeGraphQt documentation.
2121
menu
2222

2323
.. toctree::
24-
:caption: Module Widgets
24+
:caption: Widgets
2525
:name: wdgtstoc
2626
:maxdepth: 2
2727

docs/node_widgets.rst

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

4-
Node widgets are widgets that can be embedded into a
4+
Node embedded widgets are the widgets that can be embedded into a
55
:class:`NodeGraphQt.BaseNode` and displayed in the node graph.
66

77
See :ref:`Embedding Custom Widgets` example to adding your own widget into a node.

0 commit comments

Comments
 (0)