From 2147cecbf1c366444d078de0e49c06916c1b94bd Mon Sep 17 00:00:00 2001
From: Eric Holscher <eric@ericholscher.com>
Date: Wed, 15 Apr 2020 14:00:50 -0700
Subject: [PATCH] Add hoverxref to our docs

---
 docs/conf.py                      | 18 +++++++++++++++++-
 requirements/local-docs-build.txt |  3 +++
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index d488aec5c2c..b25010f2fd3 100644
--- 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
index 1ce96b89356..2b91a4b4d49 100644
--- 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