Skip to content

Commit dee2947

Browse files
Update documentation about themes
1 parent 44e5b3b commit dee2947

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

src/doc/rustdoc/src/how-to-read-rustdoc.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,8 @@ or the current item whose documentation is being displayed.
5959
## The Theme Picker and Search Interface
6060

6161
When viewing `rustdoc`'s output in a browser with JavaScript enabled,
62-
a dynamic interface appears at the top of the page.
63-
To the left is the theme picker, denoted with a paint-brush icon,
64-
and the search interface, help screen, and options appear to the right of that.
65-
66-
### The Theme Picker
67-
68-
Clicking on the theme picker provides a list of themes -
69-
by default `ayu`, `light`, and `dark` -
70-
which are available for viewing.
62+
a dynamic interface appears at the top of the page composed of the search
63+
interface, help screen, and options.
7164

7265
### The Search Interface
7366

@@ -91,12 +84,16 @@ When typing in the search bar, you can prefix your search term with a type
9184
followed by a colon (such as `mod:`) to restrict the results to just that
9285
kind of item. (The available items are listed in the help popup.)
9386

87+
### Changing displayed theme
88+
89+
You can change the displayed theme by opening the settings menu (the gear
90+
icon in the upper right) and then pick a new one from there.
91+
9492
### Shortcuts
9593

9694
Pressing `S` while focused elsewhere on the page will move focus to the
9795
search bar, and pressing `?` shows the help screen,
9896
which includes all these shortcuts and more.
99-
Pressing `T` focuses the theme picker.
10097

10198
When the search results are focused,
10299
the left and right arrows move between tabs and the up and down arrows move

src/doc/rustdoc/src/write-documentation/what-to-include.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,9 @@ rustdoc --extend-css custom.css src/lib.rs
109109

110110
A good example of using this feature to create a dark theme is documented [on
111111
this blog]. Just remember, dark theme is already included in the rustdoc output
112-
by clicking on the paintbrush. Adding additional options to the themes are
113-
as easy as creating a custom theme `.css` file and using the following syntax:
112+
by clicking on the gear icon in the upper right. Adding additional options to the
113+
themes are as easy as creating a custom theme `.css` file and using the following
114+
syntax:
114115

115116
```bash
116117
rustdoc --theme awesome.css src/lib.rs

0 commit comments

Comments
 (0)