Skip to content

Commit 060e61b

Browse files
committed
doc updates
1 parent fab1232 commit 060e61b

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

Diff for: docs/examples/ex_menu.rst

+13-5
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
11
Menu Overview
22
#############
33

4-
Examples for customizing context menus in NodeGraphQt.
4+
.. currentmodule:: NodeGraphQt
5+
6+
| Examples for customizing context menus in NodeGraphQt.
57
68
Default Context Menu
79
********************
810

9-
The ``NodeGraphQt.NodeGraph`` has a default context menu with a few essential
10-
menu commands built when initialized it can be accessed with the
11-
:meth:`NodeGraph.context_menu` function.
11+
The ``NodeGraphQt.NodeGraph`` has a context menu can be accessed with
12+
:meth:`NodeGraph.context_menu`.
13+
14+
15+
It can also be populated it with a config file in ``JSON`` format by using
16+
:meth:`NodeGraph.set_context_menu_from_file`.
1217

1318
.. image:: ../_images/menu_hotkeys.png
1419
:width: 300px
1520

21+
| Here's a link to the example config file with a few essential menu commands.
22+
| https://github.com/jchanvfx/NodeGraphQt/blob/master/examples/hotkeys/hotkeys.json
23+
1624
Adding to the Graph Menu
1725
************************
1826

@@ -49,7 +57,7 @@ Adding to the Nodes Menu
4957
Aside from the main context menu, the NodeGraph also has a nodes menu where you
5058
can override context menus on a per node type basis.
5159

52-
Below is an example for overriding a context menu for the node type ``"com.chantasticvfx.FooNode"``
60+
| Below is an example for overriding a context menu for the node type ``"com.chantasticvfx.FooNode"``
5361
5462
.. code-block:: python
5563
:linenos:

Diff for: docs/menu.rst

+8-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,16 @@ Menus
33

44
.. currentmodule:: NodeGraphQt
55

6+
.. seealso::
7+
8+
Context menus can also be set from a config file or a dictionary with:
9+
:meth:`NodeGraph.set_context_menu_from_file`, :meth:`NodeGraph.set_context_menu`
10+
11+
612
Graph Menu
713
**********
814

9-
The context menu triggered from the node graph.
15+
| The context menu triggered from the node graph.
1016
1117
.. autoclass:: NodeGraphMenu
1218
:members:
@@ -16,7 +22,7 @@ The context menu triggered from the node graph.
1622
Nodes Menu
1723
**********
1824

19-
The context menu triggered from a node.
25+
| The context menu triggered from a node.
2026
2127
.. autoclass:: NodesMenu
2228
:members:

0 commit comments

Comments
 (0)