From b3c0865d9d31e5bf17e2c8fe64f85182a6bca44d Mon Sep 17 00:00:00 2001 From: Harmon Date: Mon, 20 Sep 2021 04:04:03 -0500 Subject: [PATCH] Use sphinx-hoverxref for documentation --- docs/conf.py | 3 +++ docs/requirements.txt | 1 + 2 files changed, 4 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 93b1594..0ad691f 100644 --- 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 ba36df9..6b4b61a 100644 --- 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 -- 2.25.1