From 71c92206246d9bb3008e6a066b10f85f9e65a4c5 Mon Sep 17 00:00:00 2001 From: Rahul Giri Date: Tue, 16 Dec 2025 17:18:46 +0530 Subject: [PATCH 1/2] Add MyST examples for menuselection and guilabel roles --- .../documentation/myst-reference.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/contributing/documentation/myst-reference.md b/docs/contributing/documentation/myst-reference.md index c854c0dd4..fa75ca1a2 100644 --- a/docs/contributing/documentation/myst-reference.md +++ b/docs/contributing/documentation/myst-reference.md @@ -394,6 +394,25 @@ print("my 1st line") print(f"my {a}nd line") ``` ```` +### GUI-related roles + +Use the following MyST roles to document interactions with graphical user interfaces. + +#### `guilabel` + +Use the `guilabel` role to refer to labels in a graphical user interface, such as buttons, menu items, or tabs. + +```{example} +Click the {guilabel}`Save` button to store your changes. +``` + +#### `menuselection` + +Use the `menuselection` role to describe a sequence of menu selections in a graphical user interface. + +```{example} +Navigate to {menuselection}`File --> Preferences --> Settings`. +``` ### Tabs From db9cb6f0ceb29a78cf7fd73f148a5cead71c3eef Mon Sep 17 00:00:00 2001 From: Rahul Giri Date: Thu, 18 Dec 2025 14:45:26 +0530 Subject: [PATCH 2/2] Update docs/contributing/documentation/myst-reference.md Co-authored-by: Steve Piercy --- docs/contributing/documentation/myst-reference.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/contributing/documentation/myst-reference.md b/docs/contributing/documentation/myst-reference.md index fa75ca1a2..dc9372d56 100644 --- a/docs/contributing/documentation/myst-reference.md +++ b/docs/contributing/documentation/myst-reference.md @@ -394,6 +394,8 @@ print("my 1st line") print(f"my {a}nd line") ``` ```` + + ### GUI-related roles Use the following MyST roles to document interactions with graphical user interfaces.