Skip to content
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/contributing/documentation/myst-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down