Merge pull request #153 from Gallaecio/sphinx-extensions-2

Add tooltips to documentation cross-references
scrapy · Feb 18, 2020 · 28e294d · 28e294d
2 parents 8207cb0 + 7461a31
commit 28e294d
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
@@ -26,6 +26,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.doctest',
@@ -257,6 +258,11 @@
 }
 
 
-# --- Nitpicking options ------------------------------------------------------
+# -- Nitpicking options -------------------------------------------------------
 
 nitpicky = True
+
+
+# -- 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