Skip to content

Commit d0e72d9

Browse files
committed
Add tooltips to documentation cross-references
1 parent 332b7e8 commit d0e72d9

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/conf.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
# Add any Sphinx extension module names here, as strings. They can be
4242
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
4343
extensions = [
44+
'hoverxref.extension',
4445
'notfound.extension',
4546
'sphinx.ext.autodoc',
4647
'sphinx.ext.intersphinx',
@@ -288,7 +289,7 @@
288289
}
289290

290291

291-
# --- Nitpicking options ------------------------------------------------------
292+
# -- Nitpicking options -------------------------------------------------------
292293

293294
nitpicky = True
294295
nitpick_ignore = [
@@ -297,3 +298,8 @@
297298
('py:class', 'cssselect.xpath.XPathExpr'),
298299
('py:class', 'lxml.etree.XMLParser'),
299300
]
301+
302+
303+
# -- sphinx-hoverxref options -------------------------------------------------
304+
305+
hoverxref_auto_ref = True

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
sphinx
2+
sphinx-hoverxref
23
sphinx-notfound-page
34
sphinx_rtd_theme

0 commit comments

Comments
 (0)