From a4f096a8d7a88b592df380daacb52726109f5081 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 18 Nov 2019 16:14:23 +0100 Subject: [PATCH] Add tooltips to documentation cross-references --- docs/conf.py | 7 ++++++- docs/requirements.txt | 1 + 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index f3c0ff6d..57fdf68e 100755 --- 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,7 @@ ('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 index ffbc6da7..27420981 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ sphinx +sphinx-hoverxref sphinx-notfound-page sphinx_rtd_theme