Merge pull request #4563 from willbeaufoy/hoverxref

Extend hoverxref_roles to custom crossrefs (#4495)
2020-06-01 07:18:13 +02:00 · 2020-06-01 07:18:13 +02:00 · c86a1035dd
parent 5cef927944 898bdd3feb
commit c86a1035dd
2 changed files with 10 additions and 0 deletions
--- a/docs/README.rst
+++ b/docs/README.rst
@ -57,3 +57,12 @@ There is a way to recreate the doc automatically when you make changes, you
 need to install watchdog (``pip install watchdog``) and then use::

    make watch
+
+Alternative method using tox
+----------------------------
+
+To compile the documentation to HTML run the following command::
+
+    tox -e docs
+
+Documentation will be generated (in HTML format) inside the ``.tox/docs/tmp/html`` dir.
--- a/docs/conf.py
+++ b/docs/conf.py
@ -303,3 +303,4 @@ hoverxref_role_types = {
    "mod": "tooltip",
    "ref": "tooltip",
 }
+hoverxref_roles = ['command', 'reqmeta', 'setting', 'signal']