diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-01-30 18:11:45 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-30 18:11:45 +0300 |
| commit | 799385f5558a888d1a143bf703d06b66d6717fe4 (patch) | |
| tree | a55024631d08ee3d933a5c8e6ee1ab642c9325f0 /doc | |
| parent | 07110b7557a552ecfe702bdd6a2d2f9685cb1af9 (diff) | |
| parent | 8cf3179ad2fb0dc55b189deba7f9a00691ed462e (diff) | |
Merge pull request #9337 from marxin/new-shortcuts
Implement new search shortcuts.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/usage/theming.rst | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/usage/theming.rst b/doc/usage/theming.rst index f66734b96..5f5417061 100644 --- a/doc/usage/theming.rst +++ b/doc/usage/theming.rst @@ -158,9 +158,18 @@ These themes are: dimension string such as '70em' or '50%'. Use 'none' if you don't want a width limit. Defaults may depend on the theme (often 800px). - - **navigation_with_keys** (true or false): Allow navigating to the - previous/next page using the keyboard's left and right arrows. Defaults to - ``False``. + - **navigation_with_keys** (true or false): Allow navigating + with the following keyboard shortcuts: + + - :kbd:`Left arrow`: previous page + - :kbd:`Right arrow`: next page + + Defaults to ``False``. + + - **enable_search_shortcuts** (true or false): Allow jumping to the search box + with :kbd:`/` and allow removal of search highlighting with :kbd:`Esc`. + + Defaults to ``True``. - **globaltoc_collapse** (true or false): Only expand subsections of the current document in ``globaltoc.html`` |