From 7461a3177215af2b19e2f26a9523db54b0483c45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 18 Nov 2019 16:15:54 +0100 Subject: [PATCH] Add tooltips to documentation cross-references --- docs/conf.py | 8 +++++++- docs/requirements.txt | 1 + 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index c8ad6e4c..cb0ec16f 100644 --- 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', @@ -255,6 +256,11 @@ } -# --- Nitpicking options ------------------------------------------------------ +# -- Nitpicking options ------------------------------------------------------- nitpicky = True + + +# -- 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