File tree Expand file tree Collapse file tree 2 files changed +6
-3
lines changed Expand file tree Collapse file tree 2 files changed +6
-3
lines changed Original file line number Diff line number Diff line change @@ -31,10 +31,13 @@ This will :hoverxref:`show a tooltip <hoverxref:hoverxref>` in the linked words.
31
31
.. tip ::
32
32
33
33
This new ``hoverxref `` role is an alias of the ``ref `` role and works in the same.
34
+ See :ref: `usage:usage ` for more detailed information about and other examples.
34
35
35
36
37
+ ----
38
+
36
39
.. toctree ::
37
- :maxdepth: 1
40
+ :maxdepth: 2
38
41
:caption: Contents
39
42
40
43
installation
@@ -44,7 +47,7 @@ This will :hoverxref:`show a tooltip <hoverxref:hoverxref>` in the linked words.
44
47
45
48
46
49
.. toctree ::
47
- :maxdepth: 1
50
+ :maxdepth: 2
48
51
:caption: API Reference
49
52
50
53
autoapi/hoverxref/index
Original file line number Diff line number Diff line change @@ -5,7 +5,7 @@ This extension defines a custom role called ``:hoverxref:``.
5
5
When this role is used, it will show a tooltip when the ``hover `` mouse event is triggered,
6
6
and will embed the content of the document/section the link is pointing to, into the tooltip's content.
7
7
8
- ``:hoverxref: `` uses Sphinx's internals reference resolution to find out where the link points to.
8
+ ``:hoverxref: `` role uses Sphinx's internals reference resolution to find out where the link points to.
9
9
So, the way of referencing the section works in the same way as the ``:ref: `` standard role.
10
10
See `Sphinx's ref role documentation `_ for more information.
11
11
You can’t perform that action at this time.
0 commit comments