Add hoverxref to our docs

readthedocs · Apr 16, 2020 · 2147cec · 2147cec
1 parent 6052f90
commit 2147cec
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,10 +34,11 @@ def get_version():
     'sphinx-prompt',
     'recommonmark',
     'notfound.extension',
+    'hoverxref.extension',
     'sphinx_search.extension',
 ]
-templates_path = ['_templates']
 
+templates_path = ['_templates']
 source_suffix = ['.rst', '.md']
 
 master_doc = 'index'
@@ -85,6 +86,21 @@ def get_version():
     'display_version': False,
 }
 
+hoverxref_auto_ref = True
+hoverxref_domains = ['py']
+hoverxref_roles = [
+    'option',
+    'doc',
+]
+hoverxref_role_types = {
+    'mod': 'modal',  # for Python Sphinx Domain
+    'doc': 'modal',  # for whole docs
+    'class': 'tooltip',  # for Python Sphinx Domain
+    'ref': 'tooltip',  # for hoverxref_auto_ref config
+    'confval': 'tooltip',  # for custom object
+}
+
+
 # Activate autosectionlabel plugin
 autosectionlabel_prefix_document = True
 

diff --git a/requirements/local-docs-build.txt b/requirements/local-docs-build.txt
@@ -19,6 +19,9 @@ git+https://github.com/agjohnson/sphinx-intl.git@7b5c66bdb30f872b3b1286e371f569c
 # Test out in-doc search
 git+https://github.com/readthedocs/readthedocs-sphinx-search@master
 
+# Test out hoverxref
+git+https://github.com/readthedocs/sphinx-hoverxref@master
+
 
 Pygments==2.6.1