Skip to content

Commit 28c11e1

Browse files
committed
doc updates
1 parent 7b0271e commit 28c11e1

File tree

3 files changed

+21
-29
lines changed

3 files changed

+21
-29
lines changed

docs/_images/overview.png

333 KB
Loading

docs/menu.rst

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,6 @@
11
Menu & Commands
22
***************
33

4-
Default Setup
5-
=============
6-
7-
The ``NodeGraphQt`` module has a built in ``setup_context_menu`` function that'll populate the node graphs
8-
context menu some default menus and commands.
9-
10-
.. image:: _images/menu_hotkeys.png
11-
:width: 50%
12-
13-
----
14-
15-
.. autofunction:: NodeGraphQt.setup_context_menu
16-
:noindex:
17-
18-
Example
19-
=======
20-
214
Here's a example where we a menu with the name "Foo" to the node graphs context menu.
225

236
.. code-block:: python
@@ -47,11 +30,27 @@ and here we add a menu command with the name "Bar" to the "Foo" menu that will e
4730
# add "Bar" command to the "Foo" menu.
4831
foo_menu.add_command('Bar', my_test, 'Shift+t')
4932
33+
Simple Setup
34+
============
35+
36+
The ``NodeGraphQt`` module has a built in method that'll populate the node graphs context menu a few
37+
default menus and commands.
38+
39+
.. image:: _images/menu_hotkeys.png
40+
:width: 50%
41+
42+
----
43+
44+
.. autofunction:: NodeGraphQt.setup_context_menu
45+
:noindex:
46+
47+
48+
5049

5150
Menu
5251
====
5352

54-
Node graph context menu.
53+
Node graph menu.
5554

5655

5756
----
@@ -63,7 +62,7 @@ Node graph context menu.
6362
Command
6463
=======
6564

66-
Node graph context menu command.
65+
Node graph menu command.
6766

6867
----
6968

docs/overview.rst

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Overview
44
NodeGraphQt is a node graph framework that can be implemented and repurposed into applications that supports ``PySide2``.
55

66
.. image:: _images/overview.png
7-
:width: 60%
7+
:width: 70%
88

99
Navigation
1010
==========
@@ -37,19 +37,12 @@ Node can be created with the tab node search widget.
3737
Menu Setup
3838
==========
3939

40-
The NodeGraphQt module has a built in :meth:`NodeGraphQt.setup_context_menu` method that'll help setup the node graphs
41-
context menu some default menus and commands.
40+
The NodeGraphQt has a ``setup_context_menu`` method that'll setup the node graphs with basic menus and commands.
4241

42+
`(see line:32 in the example code below)`
4343

4444
see also: :ref:`Menu & Commands`
4545

46-
.. image:: _images/menu_hotkeys.png
47-
:width: 50%
48-
49-
----
50-
51-
.. autofunction:: NodeGraphQt.setup_context_menu
52-
5346

5447
Example
5548
=======

0 commit comments

Comments
 (0)