Add tooltips to documentation cross-references

scrapy · Nov 21, 2019 · d0e72d9 · d0e72d9
1 parent 332b7e8
commit d0e72d9
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -41,6 +41,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    'hoverxref.extension',
     'notfound.extension',
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
@@ -288,7 +289,7 @@
 }
 
 
-# --- Nitpicking options ------------------------------------------------------
+# -- Nitpicking options -------------------------------------------------------
 
 nitpicky = True
 nitpick_ignore = [
@@ -297,3 +298,8 @@
     ('py:class', 'cssselect.xpath.XPathExpr'),
     ('py:class', 'lxml.etree.XMLParser'),
 ]
+
+
+# -- sphinx-hoverxref options -------------------------------------------------
+
+hoverxref_auto_ref = True
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
 sphinx
+sphinx-hoverxref
 sphinx-notfound-page
 sphinx_rtd_theme