Skip to content

Commit 778e63b

Browse files
committed
Add a guideline for referring to GUI elements
Resolves #2823
1 parent 3f51045 commit 778e63b

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

doc/contributing/docs/markup.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ This section will guide you through our typical documentation formatting cases.
1717
markup/links
1818
markup/tables
1919
markup/code
20+
markup/gui
2021
markup/admonitions

doc/contributing/docs/markup/gui.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Referring to GUI elements
2+
=========================
3+
4+
To mention a GUI element, use the ``:gui:`` directive:
5+
6+
.. code-block:: rst
7+
8+
Click the :gui:`OK` button.

0 commit comments

Comments
 (0)