Use sphinx-hoverxref for documentation

diff --git a/docs/conf.py b/docs/conf.py
index 93b1594d88f61987f9c7532e45ebed42f8e0a4ee..0ad691f23ac84184f77fcbda04e3253c9e210846 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -25,6 +25,7 @@ sys.path.append(os.path.abspath('..'))
 # 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',
   'myst_parser',
   'sphinx.ext.autodoc',
   'sphinx.ext.autosectionlabel',
@@ -32,6 +33,8 @@ extensions = [
   'sphinx.ext.napoleon'
 ]
 
+hoverxref_auto_ref = True
+
 intersphinx_mapping = {
   'python': ('https://docs.python.org/3', None),
   'aiohttp': ('https://docs.aiohttp.org/en/stable/', None),

diff --git a/docs/requirements.txt b/docs/requirements.txt
index ba36df9a31d2b590ff164f2e08b84c1345e51f2a..6b4b61ac563015961bb1942b7b39829e4a961c56 100644 (file)
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,3 +1,4 @@
 myst-parser==0.14.0
 sphinx==3.5.4
+sphinx-hoverxref==0.7b1
 sphinx_rtd_theme==0.5.2