Skip to content

Commit bc80c44

Browse files
committed
Improve warning note
1 parent d899a34 commit bc80c44

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ you can use ``:hoverxref:`` role to show tooltip when hovering with the mouse.
3636

3737
.. warning::
3838

39-
This extension **requires a backend server** to work.
39+
This extension **requires a backend server** to retrieve the tooltip content.
4040
Currently only `Read the Docs`_ is supported,
41-
so you need to host your documentation on Read the Docs for the extension to work properly.
41+
so it will only work if your documentation is hosted on Read the Docs.
4242

4343
If you prefer to apply this behavior to *all* your ``:ref:`` in your documentation,
4444
you can use the config :confval:`hoverxref_auto_ref`.

0 commit comments

Comments
 (0)