Skip to content

Commit dfdaba3

Browse files
committed
Max depth: 2 and link to usage from home's Tip
1 parent cd89eeb commit dfdaba3

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

docs/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,13 @@ This will :hoverxref:`show a tooltip <hoverxref:hoverxref>` in the linked words.
3131
.. tip::
3232

3333
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.
3435

3536

37+
----
38+
3639
.. toctree::
37-
:maxdepth: 1
40+
:maxdepth: 2
3841
:caption: Contents
3942

4043
installation
@@ -44,7 +47,7 @@ This will :hoverxref:`show a tooltip <hoverxref:hoverxref>` in the linked words.
4447

4548

4649
.. toctree::
47-
:maxdepth: 1
50+
:maxdepth: 2
4851
:caption: API Reference
4952

5053
autoapi/hoverxref/index

docs/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This extension defines a custom role called ``:hoverxref:``.
55
When this role is used, it will show a tooltip when the ``hover`` mouse event is triggered,
66
and will embed the content of the document/section the link is pointing to, into the tooltip's content.
77

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.
99
So, the way of referencing the section works in the same way as the ``:ref:`` standard role.
1010
See `Sphinx's ref role documentation`_ for more information.
1111

0 commit comments

Comments
 (0)