Skip to content

Commit 65d3bc0

Browse files
committed
DOC: add instructions to index page, hide main TOC
1 parent a48a52c commit 65d3bc0

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

doc/index.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
----
44

5+
.. raw:: html
6+
7+
<details>
8+
<summary>click here to see full table of contents</summary>
9+
510
.. toctree::
611

712
installation
@@ -14,3 +19,41 @@
1419
.. only:: html
1520

1621
:ref:`genindex`
22+
23+
.. raw:: html
24+
25+
</details>
26+
27+
.. only:: html
28+
29+
.. admonition:: How To Navigate This Site
30+
31+
Use the *next* and *previous* links at the top and the bottom of each page
32+
to flip through the pages.
33+
Alternatively, you can use the right and left arrow keys
34+
on your keyboard.
35+
Some additional keyboard shortcuts
36+
are provided via the `accesskey feature`__:
37+
:kbd:`n` next,
38+
:kbd:`p` previous,
39+
:kbd:`u` up (= to the parent page),
40+
:kbd:`i` index,
41+
:kbd:`s` search and
42+
:kbd:`m` menu (= open/close sidebar).
43+
44+
__ https://developer.mozilla.org/en-US/docs/
45+
Web/HTML/Global_attributes/accesskey
46+
47+
Click on the `hamburger button`__ in the topbar
48+
to open and close the sidebar.
49+
The width of the sidebar can be adjusted by dragging its border.
50+
Click on the title in the topbar to scroll to the top of the page,
51+
if already at the top, go "up" to the parent page
52+
(eventually ending up on this very page).
53+
54+
__ https://en.wikipedia.org/wiki/Hamburger_button
55+
56+
On *touch-enabled* devices:
57+
Tap at the top of the page to show the topbar (if it was scrolled away);
58+
swipe from the left edge to show the sidebar,
59+
swipe towards the left to hide it.

0 commit comments

Comments
 (0)