Skip to content

Commit d899a34

Browse files
committed
Add a warning not saying that Read the Docs is required
1 parent 235dc99 commit d899a34

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/installation.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,16 @@ To do this, add this extension to your Sphinx's extensions in the ``conf.py`` fi
3434
After installing the package and adding the extension in the ``conf.py`` file,
3535
you can use ``:hoverxref:`` role to show tooltip when hovering with the mouse.
3636

37+
.. warning::
38+
39+
This extension **requires a backend server** to work.
40+
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.
42+
3743
If you prefer to apply this behavior to *all* your ``:ref:`` in your documentation,
3844
you can use the config :confval:`hoverxref_auto_ref`.
3945

4046
See :ref:`usage:usage` for more use cases and :ref:`configuration:configuration` for a full list of available configs.
47+
48+
49+
.. _Read the Docs: https://readthedocs.org/

0 commit comments

Comments
 (0)